Skip to content

Commit 2cb09ae

Browse files
committed
Fixed #4443 - Added wording to clarify the differences between --json and --json-pp
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent cd4574f commit 2cb09ae

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/source/cli-reference/synopsis.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,18 @@ Output Formats
8080
--------------
8181

8282
The output file format is set by using the various output options. See
83-
:ref:`scan_output_options`. The recommended output format is JSON. If
84-
``--json`` is used, the entire file being in one line, without whitespace
85-
characters.
83+
:ref:`scan_output_options`. The recommended output format is JSON.
84+
85+
If ``--json`` is used, the entire file being in one line, without
86+
whitespace characters. If ``--json-pp`` is used, the output is in a
87+
pretty-printed JSON format—structured with indentation and line breaks to
88+
make it more human-readable, rather than compressed into a single line.
89+
90+
The following example scans will show you how to run a scan with each of
91+
the result formats. For the scans, we will use the ``samples`` directory
92+
provided with the ScanCode-Toolkit, along with the ``--json-pp`` output
93+
option.
8694

87-
The following example scans will show you how to run a scan with each of the result formats. For
88-
the scans, we will use the ``samples`` directory provided with the ScanCode Toolkit.
8995

9096
.. include:: /rst_snippets/tip_snippets/stdout.rst
9197

0 commit comments

Comments
 (0)