mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-26 01:37:20 +00:00
Code Issues Releases Wiki Activity

docs: --format is required for some expensive-to-compute values

Browse source 
borg list by default does not compute expensive values except when
they are needed. whether they are needed is determined by the format,
in standard mode as well as in --json mode.

(cherry picked from commit fc6e81c8bb)
This commit is contained in:
Thomas Waldmann 2018-12-07 01:18:32 +01:00
parent 3837441e08
commit c6fe7265c4
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/internals/frontends.rst
View file

@ -340,6 +340,16 @@ username
comment
Archive comment, if any
Some keys/values are more expensive to compute than others (e.g. because it requires opening the archive,
not just the manifest). To optimize for speed, `borg list repo` does not determine these values except
when they are requested. The `--format` option is used for that (for normal mode as well as for `--json`
mode), so, to have the comment included in the json output, you will need:
::
borg list repo --format "{name}{comment}" --json`
Example of a simple archive listing (``borg list --last 1 --json``)::
{