Skip to content

Commit 5c53e7b

Browse files
committed
Fixed #1330 - Update doc to reference --license-text is not compatiable with --csv output
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 553a26b commit 5c53e7b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/source/cli-reference/basic-options.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -538,6 +538,12 @@
538538

539539
The option ``--license-text-diagnostics`` is a sub-option of ``--license-text``.
540540

541+
.. admonition:: Attention
542+
543+
The option ``--license-text`` will not work with the ``--csv``
544+
output as outputting full license texts in a CSV file doesn't serve
545+
a practical purpose.
546+
541547
With the ``--license-text`` option, the scan results attribute "matched text" includes the matched text
542548
for the detected license.
543549

0 commit comments

Comments
 (0)