From 86ea4356af1cdb65c3837cc21b2322813634df88 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 29 Jun 2023 15:38:37 -0400 Subject: [PATCH] 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. --- doc/git-annex-mirror.mdwn | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/git-annex-mirror.mdwn b/doc/git-annex-mirror.mdwn index 3dfb9aa938..36453744b4 100644 --- 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.