a325524454
Added a --json-exceptions option, which makes some exceptions be output in json. The distinction is that --json-error-messages is for messages relating to a particular ActionItem, while --json-exceptions is for messages that are not, eg ones for a file that does not exist. It's unfortunate that we need two switches with such a fine distinction between them, but I'm worried about maintaining backwards compatability in the json output, to avoid breaking anything that parses it, and this was the way to make sure I didn't. toplevelWarning is generally used for the latter kind of message. And the other calls to toplevelWarning could be converted to showException. The only possible gotcha is that if toplevelWarning is ever called after starting acting on a file, it will add to the --json-error-messages of the json displayed for that file and converting to showException would be a behavior change. That seems unlikely, but I didn't convery everything to avoid needing to satisfy myself it was not a concern. Sponsored-by: Dartmouth College's Datalad project
82 lines
1.9 KiB
Markdown
82 lines
1.9 KiB
Markdown
# NAME
|
|
|
|
git-annex info - information about an item or the repository
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex info `[directory|file|treeish|remote|description|uuid ...]`
|
|
|
|
# DESCRIPTION
|
|
|
|
Displays statistics and other information for the specified item,
|
|
which can be a directory, or a file, or a treeish, or a remote,
|
|
or the description or uuid of a repository.
|
|
|
|
When no item is specified, displays statistics and information
|
|
for the local repository and all annexed content.
|
|
|
|
# OPTIONS
|
|
|
|
* `--fast`
|
|
|
|
Only show the data that can be gathered quickly.
|
|
|
|
* `--json`
|
|
|
|
Enable JSON output. This is intended to be parsed by programs that use
|
|
git-annex. Each line of output is a JSON object corresponding to a item
|
|
being processed.
|
|
|
|
* `--json-error-messages`
|
|
|
|
Adds an "error-messages" field to the JSON that contains messages that
|
|
would normally be output to the standard error when processing a item.
|
|
|
|
* `--json-exceptions`
|
|
|
|
Output additional JSON objects for some exceptions that are not
|
|
associated with a particular item.
|
|
|
|
* `--bytes`
|
|
|
|
Show file sizes in bytes, disabling the default nicer units.
|
|
|
|
* `--batch`
|
|
|
|
Enable batch mode, in which a line containing an item is read from stdin,
|
|
the information about it is output to stdout, and repeat.
|
|
|
|
* `-z`
|
|
|
|
Makes the `--batch` input be delimited by nulls instead of the usual
|
|
newlines.
|
|
|
|
* `--autoenable`
|
|
|
|
Display a list of special remotes that have been configured to
|
|
autoenable.
|
|
|
|
* matching options
|
|
|
|
The [[git-annex-matching-options]](1) can be used to select what
|
|
to include in the statistics.
|
|
|
|
* Also the [[git-annex-common-options]](1) can be used.
|
|
|
|
# EXAMPLES
|
|
|
|
Suppose you want to run "git annex get .", but
|
|
would first like to see how much disk space that will use.
|
|
Then run:
|
|
|
|
git annex info --fast . --not --in here
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|