add --json-error-messages (not yet implemented)

Added --json-error-messages option, which includes error messages in the
json output, rather than outputting them to stderr.

The actual rediretion of errors is not implemented yet, this is only
the docs and option plumbing.

This commit was supported by the NSF-funded DataLad project.

18 files changed, 80 insertions, 8 deletions

diff --git a/doc/git-annex-add.mdwn b/doc/git-annex-add.mdwn
index 2ebbbac06..432d91a64 100644
--- a/doc/git-annex-add.mdwn
+++ b/doc/git-annex-add.mdwn
@@ -66,6 +66,10 @@ annexed content, and other symlinks.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 * `--batch`
 
   Enables batch mode, in which a file to add is read in a line from stdin,
diff --git a/doc/git-annex-addurl.mdwn b/doc/git-annex-addurl.mdwn
index a43976b56..2f6d878fb 100644
--- a/doc/git-annex-addurl.mdwn
+++ b/doc/git-annex-addurl.mdwn
@@ -97,6 +97,10 @@ be used to get better filenames.
 
   Include progress objects in JSON output.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # CAVEATS
 
 If annex.largefiles is configured, and does not match a file, `git annex
diff --git a/doc/git-annex-copy.mdwn b/doc/git-annex-copy.mdwn
index c15a29f72..22d1a1b8a 100644
--- a/doc/git-annex-copy.mdwn
+++ b/doc/git-annex-copy.mdwn
@@ -97,6 +97,10 @@ Copies the content of files from or to another remote.
 
   Include progress objects in JSON output.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-drop.mdwn b/doc/git-annex-drop.mdwn
index 7b052bee0..651b5377d 100644
--- a/doc/git-annex-drop.mdwn
+++ b/doc/git-annex-drop.mdwn
@@ -87,6 +87,10 @@ safe to do so.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-dropkey.mdwn b/doc/git-annex-dropkey.mdwn
index 0107ab538..abdd86120 100644
--- a/doc/git-annex-dropkey.mdwn
+++ b/doc/git-annex-dropkey.mdwn
@@ -29,6 +29,10 @@ exist; using it can easily result in data loss.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-examinekey.mdwn b/doc/git-annex-examinekey.mdwn
index 49bc95711..fd4ea570b 100644
--- a/doc/git-annex-examinekey.mdwn
+++ b/doc/git-annex-examinekey.mdwn
@@ -33,6 +33,10 @@ that can be determined purely by looking at the key.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 * `--batch`
 
   Enable batch mode, in which a line containing a key is read from stdin,
diff --git a/doc/git-annex-find.mdwn b/doc/git-annex-find.mdwn
index 9c578c245..71ada78c9 100644
--- a/doc/git-annex-find.mdwn
+++ b/doc/git-annex-find.mdwn
@@ -54,6 +54,10 @@ finds files in the current directory and its subdirectories.
   This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 * `--batch`
 
   Enables batch mode, in which a file is read in a line from stdin,
diff --git a/doc/git-annex-fsck.mdwn b/doc/git-annex-fsck.mdwn
index a320bb8a3..037ec2628 100644
--- a/doc/git-annex-fsck.mdwn
+++ b/doc/git-annex-fsck.mdwn
@@ -98,6 +98,10 @@ With parameters, only the specified files are checked.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # OPTIONS
 
 # SEE ALSO
diff --git a/doc/git-annex-get.mdwn b/doc/git-annex-get.mdwn
index b7f2f74b2..0fd10f1ea 100644
--- a/doc/git-annex-get.mdwn
+++ b/doc/git-annex-get.mdwn
@@ -106,6 +106,10 @@ or transferring them from some kind of key-value store.
 
   Include progress objects in JSON output.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-import.mdwn b/doc/git-annex-import.mdwn
index 3684505b6..020e57325 100644
--- a/doc/git-annex-import.mdwn
+++ b/doc/git-annex-import.mdwn
@@ -81,6 +81,10 @@ Several options can be used to adjust handling of duplicate files.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # CAVEATS
 
 Note that using `--deduplicate` or `--clean-duplicates` with the WORM
diff --git a/doc/git-annex-info.mdwn b/doc/git-annex-info.mdwn
index 896522944..a2511a509 100644
--- a/doc/git-annex-info.mdwn
+++ b/doc/git-annex-info.mdwn
@@ -26,6 +26,10 @@ for the repository as a whole.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 * `--bytes`
 
   Show file sizes in bytes, disabling the default nicer units.
diff --git a/doc/git-annex-lock.mdwn b/doc/git-annex-lock.mdwn
index cf4910b95..02495073b 100644
--- a/doc/git-annex-lock.mdwn
+++ b/doc/git-annex-lock.mdwn
@@ -23,6 +23,10 @@ the files any longer, or have made modifications you want to discard.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-metadata.mdwn b/doc/git-annex-metadata.mdwn
index fa1a884b3..509273488 100644
--- a/doc/git-annex-metadata.mdwn
+++ b/doc/git-annex-metadata.mdwn
@@ -112,6 +112,10 @@ automatically.
 
 	{"command":"metadata","file":"foo","key":"...","author":["bar"],...,"note":"...","success":true}
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 * `--batch`
 
   Enables batch mode, which can be used to both get, store, and unset
diff --git a/doc/git-annex-mirror.mdwn b/doc/git-annex-mirror.mdwn
index b7644a75d..0c6e92126 100644
--- a/doc/git-annex-mirror.mdwn
+++ b/doc/git-annex-mirror.mdwn
@@ -75,6 +75,10 @@ contents. Use [[git-annex-sync]](1) for that.
 
   Include progress objects in JSON output.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-move.mdwn b/doc/git-annex-move.mdwn
index 4e42e934f..19bc2db68 100644
--- a/doc/git-annex-move.mdwn
+++ b/doc/git-annex-move.mdwn
@@ -92,6 +92,10 @@ Moves the content of files from or to another remote.
 
   Include progress objects in JSON output.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-status.mdwn b/doc/git-annex-status.mdwn
index 3a897dc24..be12d484f 100644
--- a/doc/git-annex-status.mdwn
+++ b/doc/git-annex-status.mdwn
@@ -18,15 +18,19 @@ Particularly useful in direct mode.
 
 # OPTIONS
 
+* `--ignore-submodules=when`
+
+  This option is passed on to git status, see its man page for
+  details.
+
 * `--json`
 
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
-* `--ignore-submodules=when`
+* `--json-error-messages`
 
-  This option is passed on to git status, see its man page for
-  details.
+  Include any error messages in the json, rather than output to stderr.
 
 # SEE ALSO
 
diff --git a/doc/git-annex-unlock.mdwn b/doc/git-annex-unlock.mdwn
index 28defa4f7..7603937bd 100644
--- a/doc/git-annex-unlock.mdwn
+++ b/doc/git-annex-unlock.mdwn
@@ -42,6 +42,10 @@ file to be lost from the local repository. So, enable annex.thin with care.
   Enable JSON output. This is intended to be parsed by programs that use
   git-annex. Each line of output is a JSON object.
 
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/git-annex-whereis.mdwn b/doc/git-annex-whereis.mdwn
index b95033cbd..b7d412d30 100644
--- a/doc/git-annex-whereis.mdwn
+++ b/doc/git-annex-whereis.mdwn
@@ -43,11 +43,6 @@ For example:
 
   Show whereis information for files found by last run of git-annex unused.
 
-* `--json`
-
-  Enable JSON output. This is intended to be parsed by programs that use
-  git-annex. Each line of output is a JSON object.
-
 * `--batch`
 
   Enables batch mode, in which a file is read in a line from stdin,
@@ -56,6 +51,15 @@ For example:
   Note that if the file is not an annexed file, an empty line will be
   output instead.
 
+* `--json`
+
+  Enable JSON output. This is intended to be parsed by programs that use
+  git-annex. Each line of output is a JSON object.
+
+* `--json-error-messages`
+
+  Include any error messages in the json, rather than output to stderr.
+
 # SEE ALSO
 
 [[git-annex]](1)