borgbackup/borg
1
1
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-09-11 12:36:12 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #4198 from ThomasWaldmann/docs-json

Browse Source 
docs: --format is required for some expensive-to-compute values
This commit is contained in:
TW 2018-12-07 01:24:24 +01:00 committed by GitHub
commit f7a5d3fb15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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``)::
{