From 84a74b80ee6d32e09bd2c1e4fdaa024e665f333d Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 19 Feb 2018 15:33:59 -0400 Subject: [PATCH] better doc for --json-error-messages Word so warnings can be included, not only errors. --- doc/git-annex-add.mdwn | 3 ++- doc/git-annex-addurl.mdwn | 3 ++- doc/git-annex-copy.mdwn | 3 ++- doc/git-annex-drop.mdwn | 3 ++- doc/git-annex-dropkey.mdwn | 3 ++- doc/git-annex-examinekey.mdwn | 3 ++- doc/git-annex-find.mdwn | 3 ++- doc/git-annex-fsck.mdwn | 3 ++- doc/git-annex-get.mdwn | 3 ++- doc/git-annex-import.mdwn | 3 ++- doc/git-annex-info.mdwn | 3 ++- doc/git-annex-lock.mdwn | 3 ++- doc/git-annex-metadata.mdwn | 3 ++- doc/git-annex-mirror.mdwn | 3 ++- doc/git-annex-move.mdwn | 3 ++- doc/git-annex-status.mdwn | 3 ++- doc/git-annex-unlock.mdwn | 3 ++- doc/git-annex-whereis.mdwn | 3 ++- 18 files changed, 36 insertions(+), 18 deletions(-) diff --git a/doc/git-annex-add.mdwn b/doc/git-annex-add.mdwn index 432d91a643..ff7bc40045 100644 --- a/doc/git-annex-add.mdwn +++ b/doc/git-annex-add.mdwn @@ -68,7 +68,8 @@ annexed content, and other symlinks. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. * `--batch` diff --git a/doc/git-annex-addurl.mdwn b/doc/git-annex-addurl.mdwn index 2f6d878fb7..4748073ed3 100644 --- a/doc/git-annex-addurl.mdwn +++ b/doc/git-annex-addurl.mdwn @@ -99,7 +99,8 @@ be used to get better filenames. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # CAVEATS diff --git a/doc/git-annex-copy.mdwn b/doc/git-annex-copy.mdwn index 22d1a1b8a1..e817fd6183 100644 --- a/doc/git-annex-copy.mdwn +++ b/doc/git-annex-copy.mdwn @@ -99,7 +99,8 @@ Copies the content of files from or to another remote. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-drop.mdwn b/doc/git-annex-drop.mdwn index 651b5377da..0c07e150d5 100644 --- a/doc/git-annex-drop.mdwn +++ b/doc/git-annex-drop.mdwn @@ -89,7 +89,8 @@ safe to do so. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-dropkey.mdwn b/doc/git-annex-dropkey.mdwn index abdd861207..6816407371 100644 --- a/doc/git-annex-dropkey.mdwn +++ b/doc/git-annex-dropkey.mdwn @@ -31,7 +31,8 @@ exist; using it can easily result in data loss. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-examinekey.mdwn b/doc/git-annex-examinekey.mdwn index fd4ea570b5..83baa56676 100644 --- a/doc/git-annex-examinekey.mdwn +++ b/doc/git-annex-examinekey.mdwn @@ -35,7 +35,8 @@ that can be determined purely by looking at the key. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. * `--batch` diff --git a/doc/git-annex-find.mdwn b/doc/git-annex-find.mdwn index 71ada78c9a..dafb0e7b3e 100644 --- a/doc/git-annex-find.mdwn +++ b/doc/git-annex-find.mdwn @@ -56,7 +56,8 @@ finds files in the current directory and its subdirectories. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. * `--batch` diff --git a/doc/git-annex-fsck.mdwn b/doc/git-annex-fsck.mdwn index 037ec26288..a9392935f1 100644 --- a/doc/git-annex-fsck.mdwn +++ b/doc/git-annex-fsck.mdwn @@ -100,7 +100,8 @@ With parameters, only the specified files are checked. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # OPTIONS diff --git a/doc/git-annex-get.mdwn b/doc/git-annex-get.mdwn index 0fd10f1ea7..2f39811654 100644 --- a/doc/git-annex-get.mdwn +++ b/doc/git-annex-get.mdwn @@ -108,7 +108,8 @@ or transferring them from some kind of key-value store. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-import.mdwn b/doc/git-annex-import.mdwn index 020e573255..c1bcbd2b98 100644 --- a/doc/git-annex-import.mdwn +++ b/doc/git-annex-import.mdwn @@ -83,7 +83,8 @@ Several options can be used to adjust handling of duplicate files. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # CAVEATS diff --git a/doc/git-annex-info.mdwn b/doc/git-annex-info.mdwn index a2511a509d..311edc4d94 100644 --- a/doc/git-annex-info.mdwn +++ b/doc/git-annex-info.mdwn @@ -28,7 +28,8 @@ for the repository as a whole. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. * `--bytes` diff --git a/doc/git-annex-lock.mdwn b/doc/git-annex-lock.mdwn index 02495073b1..c13654dbe3 100644 --- a/doc/git-annex-lock.mdwn +++ b/doc/git-annex-lock.mdwn @@ -25,7 +25,8 @@ the files any longer, or have made modifications you want to discard. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-metadata.mdwn b/doc/git-annex-metadata.mdwn index 5092734881..7786d999b2 100644 --- a/doc/git-annex-metadata.mdwn +++ b/doc/git-annex-metadata.mdwn @@ -114,7 +114,8 @@ automatically. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. * `--batch` diff --git a/doc/git-annex-mirror.mdwn b/doc/git-annex-mirror.mdwn index 0c6e921261..d665a6e774 100644 --- a/doc/git-annex-mirror.mdwn +++ b/doc/git-annex-mirror.mdwn @@ -77,7 +77,8 @@ contents. Use [[git-annex-sync]](1) for that. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-move.mdwn b/doc/git-annex-move.mdwn index 19bc2db68e..ce932b1982 100644 --- a/doc/git-annex-move.mdwn +++ b/doc/git-annex-move.mdwn @@ -94,7 +94,8 @@ Moves the content of files from or to another remote. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-status.mdwn b/doc/git-annex-status.mdwn index be12d484f4..f322606e8d 100644 --- a/doc/git-annex-status.mdwn +++ b/doc/git-annex-status.mdwn @@ -30,7 +30,8 @@ Particularly useful in direct mode. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-unlock.mdwn b/doc/git-annex-unlock.mdwn index 7603937bd5..b5dcc7e5e7 100644 --- a/doc/git-annex-unlock.mdwn +++ b/doc/git-annex-unlock.mdwn @@ -44,7 +44,8 @@ file to be lost from the local repository. So, enable annex.thin with care. * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO diff --git a/doc/git-annex-whereis.mdwn b/doc/git-annex-whereis.mdwn index b7d412d30a..8ce8c6df18 100644 --- a/doc/git-annex-whereis.mdwn +++ b/doc/git-annex-whereis.mdwn @@ -58,7 +58,8 @@ For example: * `--json-error-messages` - Include any error messages in the json, rather than output to stderr. + Messages that would normally be output to standard error are included in + the json instead. # SEE ALSO