From 0b5bb8dfecdf594b8ed003cf0d381a089a758ba2 Mon Sep 17 00:00:00 2001 From: Thalian Date: Sun, 15 Mar 2020 20:37:28 +0100 Subject: [PATCH] =?UTF-8?q?[DOCS]=20#4073=20=E2=80=93=20PlaceholderError?= =?UTF-8?q?=20not=20printed=20as=20JSON?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a warning for --log-json option that parsing errors will always be printed as plain text. --- docs/internals/frontends.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/internals/frontends.rst b/docs/internals/frontends.rst index 645bff141..66b14d6f3 100644 --- a/docs/internals/frontends.rst +++ b/docs/internals/frontends.rst @@ -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,