浏览代码

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.
Thomas Waldmann 6 年之前
父节点
当前提交
fc6e81c8bb
共有 1 个文件被更改,包括 10 次插入0 次删除
  1. 10 0
      docs/internals/frontends.rst

+ 10 - 0
docs/internals/frontends.rst

@@ -340,6 +340,16 @@ username
 comment
 comment
     Archive comment, if any
     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``)::
 Example of a simple archive listing (``borg list --last 1 --json``)::
 
 
     {
     {