mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

[DOCS] #4073 – PlaceholderError not printed as JSON 

Add a warning for --log-json option that parsing errors will always be printed as plain text.
This commit is contained in:
Thalian 2020-03-15 20:37:28 +01:00
parent c140dc995f
commit 0b5bb8dfec
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/internals/frontends.rst
View File

@ -36,6 +36,10 @@ Especially for graphical frontends it is important to be able to convey and refo
in meaningful ways. The ``--log-json`` option turns the stderr stream of Borg into a stream of JSON lines,
where each line is a JSON object. The *type* key of the object determines its other contents.
.. warning:: JSON logging requires successful argument parsing. Even with ``--log-json`` specified, a
parsing error will be printed in plain text, because logging set-up happens after all arguments are
parsed.
Since JSON can only encode text, any string representing a file system path may miss non-text parts.
The following types are in use. Progress information is governed by the usual rules for progress information,