From c6fe7265c48034ac4fc065980778ee8e7b66ecd2 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Fri, 7 Dec 2018 01:18:32 +0100 Subject: [PATCH] docs: --format is required for some expensive-to-compute values 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 fc6e81c8bbefacc5f2b762c2e97b4005d6f392cf) --- docs/internals/frontends.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/internals/frontends.rst b/docs/internals/frontends.rst index 95d91dc50..47c805173 100644 --- a/docs/internals/frontends.rst +++ b/docs/internals/frontends.rst @@ -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``):: {