Skip to content

Commit 9e287a5

Browse files
authored
Update specification.rst
Add document about the "licenses" groupping in the gerenated ABOUT files Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 08a541a commit 9e287a5

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/source/specification.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,33 @@ Optional Licensing fields
319319
- spdx_license_key: The ScanCode LicenseDB spdx_license_key defined
320320
for the license at https://scancode-licensedb.aboutcode.org/index.html
321321

322+
Notes
323+
^^^^^
324+
The license_* fields in the generated .ABOUT files are grouped under the "licenses" fields.
325+
For instance,
326+
327+
.. code-block:: none
328+
329+
licenses:
330+
- key: apache-2.0
331+
name: Apache 2.0
332+
file: apache-2.0.LICENSE
333+
url: https://scancode-licensedb.aboutcode.org/apache-2.0.LICENSE
334+
spdx_license_key: Apache-2.0
335+
336+
However, if user create .ABOUT file manually, it can also used the individual field name.
337+
338+
339+
.. code-block:: none
340+
341+
license_key: apache-2.0
342+
license_name: Apache 2.0
343+
license_file: apache-2.0.LICENSE
344+
license_url: https://scancode-licensedb.aboutcode.org/apache-2.0.LICENSE
345+
spdx_license_key: Apache-2.0
346+
347+
These groupping is only used in the generated .ABOUT files. The output from **gen** will use the individual field name.
348+
322349
Optional Boolean flag fields
323350
----------------------------
324351

0 commit comments

Comments
 (0)