upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-03-15 15:13:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[DOCS] borgbackup#4073 – PlaceholderError not printed as JSON

Browse source 
Backport from master:
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 21:28:21 +01:00
parent bd0d756c3e
commit 97c26c2af5
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,