Skip to content

Commit 45d9752

Browse files
committed
Merge branch 'develop' of github.com:nexB/aboutcode-toolkit into develop
2 parents 9acae9b + 8c4b8f9 commit 45d9752

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

docs/source/reference.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -772,3 +772,11 @@ Special Notes
772772
When using the field_filters configuration, all the standard required
773773
columns (about_resource and name) and the user defined required_fields
774774
need to be included.
775+
776+
Notes
777+
=====
778+
The AboutCode Toolkit version 10.0.0 will work with input from Scancode Toolkit
779+
version 32.0.0 or later. If you are using an earlier version of Scancode Toolkit,
780+
specifically version 31 or older, it will only be compatible with prior versions
781+
of AboutCode Toolkit.
782+

docs/source/specification.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,34 @@ 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**
348+
will use the individual field name.
349+
322350
Optional Boolean flag fields
323351
----------------------------
324352

0 commit comments

Comments
 (0)