mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

close bug with some caveats

Browse source
This commit is contained in:
Joey Hess 2011-09-01 16:11:21 -04:00
parent 5bc32c7f34
commit e4a74c0dc5
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/bugs/add_script-friendly_output_options.mdwn
View file

@ -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]]