Browse Source

docs/frontends: use headlines - you can link to them

Marian Beermann 8 years ago
parent
commit
1418aeadad
1 changed files with 7 additions and 4 deletions
  1. 7 4
      docs/internals/frontends.rst

+ 7 - 4
docs/internals/frontends.rst

@@ -270,10 +270,12 @@ Example *borg info* output::
             "last_modified": "Mon, 2017-02-27 21:21:58",
             "location": "/home/user/testrepo"
         },
-        "security_dir": "/home/user/.config/borg/security/0cbe6166b46627fd26b97f8831e2ca97584280a46714ef84d2b668daf8271a23"
+        "security_dir": "/home/user/.config/borg/security/0cbe6166b46627fd26b97f8831e2ca97584280a46714ef84d2b668daf8271a23",
+        "archives": []
     }
 
-.. rubric:: Archive formats
+Archive formats
++++++++++++++++
 
 :ref:`borg_info` uses an extended format for archives, which is more expensive to retrieve, while
 :ref:`borg_list` uses a simpler format that is faster to retrieve. Either return archives in an
@@ -390,7 +392,8 @@ The same archive with more information (``borg info --last 1 --json``)::
         }
     }
 
-.. rubric:: File listings
+File listings
++++++++++++++
 
 Listing the contents of an archive can produce *a lot* of JSON. Since many JSON implementations
 don't support a streaming mode of operation, which is pretty much required to deal with this amount of
@@ -400,7 +403,7 @@ a number of JSON objects separated by new lines.
 Each item (file, directory, ...) is described by one object in the :ref:`borg_list` output.
 Refer to the *borg list* documentation for the available keys and their meaning.
 
-Example (excerpt)::
+Example (excerpt) of ``borg list --json-lines``::
 
     {"type": "d", "mode": "drwxr-xr-x", "user": "user", "group": "user", "uid": 1000, "gid": 1000, "path": "linux", "healthy": true, "source": "", "linktarget": "", "flags": null, "isomtime": "Sat, 2016-05-07 19:46:01", "size": 0}
     {"type": "d", "mode": "drwxr-xr-x", "user": "user", "group": "user", "uid": 1000, "gid": 1000, "path": "linux/baz", "healthy": true, "source": "", "linktarget": "", "flags": null, "isomtime": "Sat, 2016-05-07 19:46:01", "size": 0}