add a warning about --json not being self describing

It was a mistake for mirror to support --json, but that happened long
ago and it doesn't seem worth removing. I doubt anyone will use it.

diff --git a/doc/git-annex-mirror.mdwn b/doc/git-annex-mirror.mdwn
index 3dfb9aa938aa18fd2a1294a2f1f90d5f35a6e1ef..36453744b46210780ffb4bcbb0eb8dd2283002fd 100644 (file)
--- a/doc/git-annex-mirror.mdwn
+++ b/doc/git-annex-mirror.mdwn
@@ -73,6 +73,9 @@ contents. Use [[git-annex-sync]](1) for that.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+  Note that unlike all other commands that support `--json`, this command
+  outputs different types of json objects in different circumstances.
+
 * `--json-progress`
 
   Include progress objects in JSON output.