File tree Expand file tree Collapse file tree 1 file changed +11
-5
lines changed
docs/source/cli-reference Expand file tree Collapse file tree 1 file changed +11
-5
lines changed Original file line number Diff line number Diff line change @@ -80,12 +80,18 @@ Output Formats
8080--------------
8181
8282The 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
You can’t perform that action at this time.
0 commit comments