From a242eabc7acd8a464157bf3a21c757e85295d8b6 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Wed, 10 May 2023 14:09:27 -0400 Subject: [PATCH] enableremote: Support --json and --json-error-messages Seems unlikely to be too useful, but who knows. Was trivial anyway. Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project --- CHANGELOG | 10 +++++----- Command/EnableRemote.hs | 9 +++++---- doc/git-annex-enableremote.mdwn | 13 ++++++++++--- ...for_unannex__and_ideally_any_other_command_.mdwn | 2 +- 4 files changed, 21 insertions(+), 13 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index fd30b986ac..2c3fc9a8f4 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -37,11 +37,11 @@ git-annex (10.20230408) UNRELEASED; urgency=medium of core.sharedRepository and umask. * initremote: Avoid creating a remote that is not encrypted when gpg is broken. - * Support --json and --json-error-messages in more commands - (addunused, dead, describe, dropunused, expire, fix, importfeed, init, - initremote, log, merge, migrate, reinit, reinject, rekey, renameremote, - rmurl, semitrust, setpresentkey, trust, unannex, undo, untrust, unused, - upgrade) + * Support --json and --json-error-messages in many more commands + (addunused, dead, describe, dropunused, enableremote, expire, fix, + importfeed, init, initremote, log, merge, migrate, reinit, reinject, + rekey, renameremote, rmurl, semitrust, setpresentkey, trust, unannex, + undo, untrust, unused, upgrade) * log: When --raw-date is used, display only seconds from the epoch, as documented, omitting a trailing "s" that was included in the output before. diff --git a/Command/EnableRemote.hs b/Command/EnableRemote.hs index d28a981842..9f364c19c9 100644 --- a/Command/EnableRemote.hs +++ b/Command/EnableRemote.hs @@ -30,10 +30,11 @@ import Git.Config import qualified Data.Map as M cmd :: Command -cmd = command "enableremote" SectionSetup - "enables git-annex to use a remote" - (paramPair paramName $ paramOptional $ paramRepeating paramParamValue) - (withParams seek) +cmd = withAnnexOptions [jsonOptions] $ + command "enableremote" SectionSetup + "enables git-annex to use a remote" + (paramPair paramName $ paramOptional $ paramRepeating paramParamValue) + (withParams seek) seek :: CmdParams -> CommandSeek seek = withWords (commandAction . start) diff --git a/doc/git-annex-enableremote.mdwn b/doc/git-annex-enableremote.mdwn index 3f07fabb76..bcc6728183 100644 --- a/doc/git-annex-enableremote.mdwn +++ b/doc/git-annex-enableremote.mdwn @@ -59,10 +59,17 @@ has found didn't work before and gave up on using, setting # OPTIONS -Most options are not prefixed by a dash, and set parameters of the remote, -as shown above. +* `--json` -Also, the [[git-annex-common-options]](1) can be used. + Enable JSON output. This is intended to be parsed by programs that use + git-annex. + +* `--json-error-messages` + + Messages that would normally be output to standard error are included in + the JSON instead. + +* Also, the [[git-annex-common-options]](1) can be used. # SEE ALSO diff --git a/doc/todo/--json_for_unannex__and_ideally_any_other_command_.mdwn b/doc/todo/--json_for_unannex__and_ideally_any_other_command_.mdwn index fef97c3345..6b748c1146 100644 --- a/doc/todo/--json_for_unannex__and_ideally_any_other_command_.mdwn +++ b/doc/todo/--json_for_unannex__and_ideally_any_other_command_.mdwn @@ -40,11 +40,11 @@ These commands have been updated to support --json: * git-annex-merge * git-annex-upgrade * git-annex-initremote +* git-annex-enableremote Provisional list of commands that don't support --json and maybe should: * git-annex-configremote -* git-annex-enableremote These commands could support json, but I punted: