diff options
| author |  Joey Hess <joey@kitenet.net> | 2011-09-01 15:16:31 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2011-09-01 15:22:06 -0400 |
| commit | 2f4d4d1c4552a93a5f26a8a0a713e3916612329e (patch) | |
| tree | a75ee41d85fc2c49ce8adf26a8c22e4f6ed6b944 /doc | |
| parent | 57dd34c6be5dbc01286108fd943ff9e02956e8aa (diff) | |
basic json support
This includes a generic JSONStream library built on top of Text.JSON
(somewhat hackishly).
It would be possible to stream out a single json document describing
all actions, but it's probably better for consumers if they can expect
one json document per line, so I did it that way instead.
Output from external programs used for transferring files is not
currently hidden when outputting json, which probably makes it not very
useful there. This may be dealt with if there is demand for json
output for --get or --move to be parsable.
The version, status, and find subcommands have hand-crafted output and
don't do json. The whereis subcommand needs to be modified to produce
useful json.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/git-annex.mdwn | 10 | ||||
| -rw-r--r-- | doc/install.mdwn | 1 |
2 files changed, 9 insertions, 2 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index e7ac9adf7..0a484a384 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -337,12 +337,18 @@ Many git-annex commands will stage changes for later `git commit` by you. * --quiet - Avoid the default verbose logging of what is done; only show errors + Avoid the default verbose display of what is done; only show errors and progress displays. * --verbose - Enable verbose logging. + Enable verbose display. + +* --json + + Rather than the normal output, generate JSON. This is intended to be + parsed by programs that use git-annex. Each line of output is a JSON + object. * --debug diff --git a/doc/install.mdwn b/doc/install.mdwn index ac521da18..cd51b96d2 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -28,6 +28,7 @@ To build and use git-annex, you will need: * [QuickCheck 2](http://hackage.haskell.org/package/QuickCheck) * [HTTP](http://hackage.haskell.org/package/HTTP) * [hS3](http://hackage.haskell.org/package/hS3) (optional, but recommended) + * [json](http://hackage.haskell.org/package/json) * Shell commands * [git](http://git-scm.com/) * [uuid](http://www.ossp.org/pkg/lib/uuid/) |