Skip to content

Commit d6baae5

Browse files
Update CHANGELOG for LicenseDetection reporting changes
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 1f88f60 commit d6baae5

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

CHANGELOG.rst

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Package detection:
6767
License detection:
6868
~~~~~~~~~~~~~~~~~~~
6969

70-
- The SPDX license list has been updated to the latest v3.19
70+
- The SPDX license list has been updated to the latest v3.20
7171

7272
- This is a major update to license detection where we now combine one or more
7373
license matches in a larger license detection. This approach improves the
@@ -78,11 +78,9 @@ License detection:
7878
- There is a new ``license_detections`` codebase level attribute with all the
7979
unique license detections in the whole scan, both in resources and packages.
8080
This has the 3 attributes also present in package/resource level license
81-
detections: ``license_expression``, ``matches`` and ``detection_log`` and has
82-
two additional attributes:
83-
84-
- ``identifier``: which is the ``license_expression`` with an UUID created out
85-
of the detection contents and is the same for same detections.
81+
detections: ``license_expression``, ``identifier`` and ``detection_log``
82+
(present optionally if the ``--license-diagnostics`` option is enabled) with
83+
an additional attribute:
8684

8785
- ``count``: Number of times in the codebase this unique license detection
8886
was encountered.
@@ -91,15 +89,14 @@ License detection:
9189

9290
- The ``licenses`` attribute is deleted.
9391

94-
- A new ``for_license_detections`` attribute is aded which references the codebase
95-
level unique license detections, and this is a list of ``identifer`` strings from
96-
the codebase level license detections it references.
97-
9892
- A new ``license_detections`` attribute contains license detections in that file.
99-
This object has three attributes: ``license_expression``, ``detection_log``
93+
This object has three attributes: ``license_expression``, ``identifier``
10094
and ``matches``. ``matches`` is a list of license matches and is roughly
10195
the same as ``licenses`` in the previous version with additional structure
102-
changes detailed below.
96+
changes detailed below. Identifier is the detected license-expression with an
97+
UUID generated from the content of ``matches`` such that this is unique for
98+
unique detections. We also have another attribute ``detection_log`` with
99+
diagnostics information if the ``--license-diagnostics`` option is enabled.
103100

104101
- A new attribute ``license_clues`` contains license matches with the
105102
same data structure as the ``matches`` attribute in ``license_detections``.
@@ -140,13 +137,14 @@ License detection:
140137
avoiding nesting. See `license updates doc <https://scancode-toolkit.readthedocs.io/en/latest/explanations/license-detection-reference.html#licensematch-result-data>`_
141138
for examples and details.
142139

143-
- There are new and codebase level attributes default with `--licenses` to report
140+
- There are new and codebase level attributes with ``--license-references`` to report
144141
reference license metadata and texts once for each license matched across the
145142
scan; we now have two codebase level attributes: ``license_references`` and
146143
``license_rule_references`` that list unique detected license and license rules.
147144
for examples and details. This reference data is also removed from license matches
148145
in all levels i.e. from codebase, package and resource level license detections and
149-
resource level license clues.
146+
resource level license clues, irrespective of this CLI option being used, i.e. default
147+
with ``--licenses``.
150148
See `license updates documentation <https://scancode-toolkit.readthedocs.io/en/latest/explanations/license-detection-reference.html#comparision-before-after-license-references>`_
151149

152150
- We replaced the ``scancode --reindex-licenses`` command line option with a
@@ -166,7 +164,7 @@ License detection:
166164

167165
- See https://github.com/nexB/scancode-toolkit/issues/480 for more details.
168166

169-
- We combined the licensedata file and text file of each license in a single
167+
- We combined the license data file and text file of each license in a single
170168
file with a .LICENSE extension. The .yml data file is now included at the
171169
top of each .LICENSE file as "YAML frontmatter". The same applies to license
172170
rules and their .RULE and .yml files. This halves the number of data files

0 commit comments

Comments
 (0)