summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-09-01 16:11:21 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-09-01 16:11:21 -0400
commite4a74c0dc533922ce1e7cd56dfa7ac08efc064cb (patch)
tree5c3278e8a25bf55b3cc7e7f383eb9554ed37023f
parent5bc32c7f3438a329878f4da7ad0b514c12a54332 (diff)
close bug with some caveats
-rw-r--r--doc/bugs/add_script-friendly_output_options.mdwn15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/bugs/add_script-friendly_output_options.mdwn b/doc/bugs/add_script-friendly_output_options.mdwn
index efcd54553..08f7e6c7b 100644
--- a/doc/bugs/add_script-friendly_output_options.mdwn
+++ b/doc/bugs/add_script-friendly_output_options.mdwn
@@ -1,3 +1,18 @@
I have a need to use git-annex from a larger program. It'd be great if the information output by some of the commands that is descriptive (for example, whereis) could be sent to stdout in a machine-readable format like (preferably) JSON, or XML. That way I can simply read in the output of the command and use the data directly instead of having to parse it via regexes or other such string manipulation.
This could perhaps be triggered by a --json or --xml flag to the relevant commands.
+
+> This is [[done]], --json is supported by all commands, more or less.
+>
+> Caveats:
+>
+> * the version, status, and find commands produce custom output and so
+> no json. This could change for version and status; find needs to just
+> be a simple list of files, I think
+> * The "note" fields may repeat multiple times per object with different
+> notes and are of course not machine readable, and subject to change.
+> * Output of helper commands like rsync is not diverted away, and
+> could clutter up the json output badly. Should only affect commands
+> that transfer data.
+>
+> --[[Joey]]