Skip to content

Commit 1842cad

Browse files
committed
docs(OutputFormats): Add Note for license references table
`--license-references` is recommended, but mention the new fallback. Signed-off-by: Jens Keim <[email protected]>
1 parent c47bf90 commit 1842cad

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/source/cli-reference/output-format.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,8 @@ Comparing Different ``json`` Output Formats
408408
- Package Information
409409
- License References (SPDX ID, Links to spdx/scancode/licensedb/License Homepage)
410410

411+
.. include:: /rst_snippets/note_snippets/output_html_license_references.rst
412+
411413
.. figure:: data/output_html1.png
412414

413415
.. figure:: data/output_html2.png
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. note::
2+
3+
For the license references table it is recommended to pass the ``--license-references`` argument.
4+
However, there is a fall back implemented in case the ``license_references`` data is missing.

0 commit comments

Comments
 (0)