git-annex/doc/git-annex-describe.mdwn
Joey Hess 365dbc89dc
expire, trust et al, dead, describe: Support --json and --json-error-messages
For expire, the normal output is unchanged, but the --json output includes the uuid
in machine parseable form. Which could be very useful for this somewhat obscure
command. That needed ActionItemUUID to be implemented, which seemed like a lot
of work, but then ---

I had been going to skip implementing them for trust, untrust, dead, semitrust,
and describe, but putting the uuid in the json is useful information, it tells
what uuid git-annex picked given the input. It was not hard to support
these once ActionItemUUID was implemented.

Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-05 15:33:30 -04:00

45 lines
995 B
Markdown

# NAME
git-annex describe - change description of a repository
# SYNOPSIS
git annex describe repository description
# DESCRIPTION
Changes the description of a repository.
The repository to describe can be specified by git remote name or
by uuid. To change the description of the current repository, use
"here".
Repository descriptions are displayed by git-annex in various places.
They are most useful when git-annex knows about a repository, but there is
no git remote corresponding to it.
# OPTIONS
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
* `--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
[[git-annex]](1)
[[git-annex-init]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.