@@ -8,25 +8,25 @@ Changelog
88Important API changes:
99~~~~~~~~~~~~~~~~~~~~~~~~
1010
11- - Adopt the new skeleton from https://github.com/nexB/skeleton
11+ - Adopted the new skeleton from https://github.com/nexB/skeleton
1212 The key change is the location of the virtual environment. It used to be
13- created at the root of the scancode-toolkit directory. Its is now created
14- instead under the ``venv `` subdirectory.
13+ created at the root of the scancode-toolkit directory. It is now created
14+ under the ``venv `` subdirectory.
1515
16- - Main package API function `get_package_infos ` is now deprecated, and is
16+ - The main package API function `get_package_infos ` is deprecated, and
1717 replaced by `get_package_data `.
1818
1919- The data structure of the JSON output has changed for copyrights, authors
20- and holders: we now use proper name for attributes and not a generic "value".
20+ and holders. We now use a proper name for attributes and not a generic "value".
2121
22- - The data structure of the JSON output has changed for licenses: we now
22+ - The data structure of the JSON output has changed for licenses. We now
2323 return match details once for each matched license expression rather than
2424 once for each license in a matched expression. There is a new top-level
25- "license_references" attributes that contains the data details for each
26- detected licenses only once. This data can contain the reference license text
25+ "license_references" attribute that contains the data details for each
26+ detected license only once. This data can contain the reference license text
2727 as an option.
2828
29- - The data structure of the JSON output has changed for packages: we now
29+ - The data structure of the JSON output has changed for packages. We now
3030 return "package_data" package information at the manifest file-level
3131 rather than "packages". This has all the data attributes of a "package_data"
3232 field plus others: "package_uuid", "package_data_files" and "files".
@@ -41,11 +41,11 @@ Important API changes:
4141 through package_uuids (pURL + uuid string).
4242
4343- The data structure for HTML output has been changed to include emails and
44- urls under the "infos" object. Now HTML template will output holders,
44+ urls under the "infos" object. The HTML template displays output for holders,
4545 authors, emails, and urls into separate tables like "licenses" and "copyrights".
4646
4747- The data structure for CSV output has been changed to rename the Resource
48- column to "path". The "copyright_holder" has been ranmed to "holder"
48+ column to "path". "copyright_holder" has been renamed to "holder"
4949
5050- The license clarity scoring plugin has been overhauled to show new license
5151 clarity criteria. More details of the new criteria are provided below.
@@ -60,7 +60,7 @@ Copyright detection:
6060~~~~~~~~~~~~~~~~~~~~
6161
6262- The data structure in the JSON is now using consistently named attributes as
63- opposed to a plain value .
63+ opposed to plain values .
6464- Several copyright detection bugs have been fixed.
6565- French and German copyright detection is improved.
6666- Some spurious trailing dots in holders are not stripped.
@@ -95,20 +95,20 @@ License detection:
9595 weakly matched. This helps detects things that look like a license but are not
9696 yet known as licenses.
9797
98- - False positive detection of "license lists" like list seen in license and
98+ - False positive detection of "license lists" like the lists seen in license and
9999 package management tools has been entirely reworked. Rather than using
100- thousands of small false positive rules, there is now a new filter to detect
101- long run of license references and tags that are typical of license lists.
100+ thousands of small false positive rules, there is a new filter to detect a
101+ long run of license references and tags that is typical of license lists.
102102 As a results, thousands of rules have been replaced by a simpler filter, and
103- the license detection is both more accurate, faster and has fewer false
103+ the license detection is more accurate, faster and has fewer false
104104 positives.
105105
106106- The new license flag "is_generic" tags licenses that are "generic" licenses
107107 such as "other-permissive" or "other-copyleft". This is not yet
108108 returned in the JSON API.
109109
110110- When scanning binary files, the detection of single word rules is filtered when
111- surrounded by gibberish or is using mixed case. For instance $#%$GpL$ is a false
111+ surrounded by gibberish or mixed case. For instance $#%$GpL$ is a false
112112 positive and is no longer reported.
113113
114114- Several rules we tagged as is_license_notice incorrectly but were references
@@ -117,14 +117,14 @@ License detection:
117117 this way.
118118
119119- Matches to small license rules (with small defined as under 15 words)
120- that are scattered on too many lines are now filtered as false matches.
120+ that are scattered over too many lines are now filtered as false matches.
121121
122122- Small, two-words matches that overlap the previous or next match by
123123 by the word "license" and assimilated are now filtered as false matches.
124124
125125- The new --licenses-reference option adds a new "licenses_reference" top
126126 level attribute to a scan when using the JSON and YAML outputs. This contains
127- all the details and the full text of every licenses seen in a file or
127+ all the details and the full text of every license seen in a file or
128128 package license expression of a scan. This can be added added after the fact
129129 using the --from-json option.
130130
@@ -142,16 +142,15 @@ Package detection:
142142 - OpenWRT packages.
143143 - Yocto/BitBake .bb recipes.
144144
145- - Major changes in packages detection and reporting, codebase-level attribute `packages `
145+ - Major changes in package detection and reporting, codebase-level attribute `packages `
146146 with one or more `package_data ` and files for the packages are reported.
147147 The specific changes made are:
148148
149149 - The resource level attribute `packages ` has been renamed to `package_data `,
150- as these are really package data that are being detected, and can be manifests,
151- lockfiles or other package data. This has all the data attributes of a `package_data `
150+ as these are really package data that are being detected, such as manifests,
151+ lockfiles or other package data. This has the data attributes of a `package_data `
152152 field plus others: `package_uuid `, `package_data_files ` and `files `.
153153
154-
155154 - A new top-level attribute `packages ` has been added which contains package
156155 instances created from `package_data ` detected in the codebase.
157156
@@ -166,17 +165,17 @@ Package detection:
166165 through package_uuids (pURL + uuid string).
167166
168167 - The package_data attribute `dependencies ` (which is a list of DependentPackages),
169- now has a new attribute `resolved_package ` having a package data mapping.
170- Also the `requirement ` attribute here is renamed to `extracted_requirement `.
168+ now has a new attribute `resolved_package ` with a package data mapping.
169+ Also the `requirement ` attribute is renamed to `extracted_requirement `.
171170
172171
173172License Clarity Scoring Update
174173~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175174
176175 - We are moving away from the license clarity scoring defined by ClearlyDefined
177176 in the license clarity score plugin. The previous license clarity scoring
178- logic produced a score that was misleading, where it would return a low score
179- when scanning packages due to the stringent scoring criteria. We are now
177+ logic produced a score that was misleading when it would return a low score
178+ due to the stringent scoring criteria. We are now
180179 using more general criteria to get a sense of what provenance information has
181180 been provided and whether or not there is a conflict in licensing between
182181 what licenses were declared at the top-level key files and what licenses have
@@ -224,7 +223,7 @@ License Clarity Scoring Update
224223
225224 - Conflicting license categories:
226225
227- - When true, indicates the declared license expression of the software is in
226+ - When true, indicates that the declared license expression of the software is in
228227 the permissive category, but that other potentially conflicting categories,
229228 such as copyleft and proprietary, have been detected in lower level code.
230229 - Scoring Weight = -20
@@ -239,7 +238,7 @@ creating a new plugin called ``tallies``. All functionality of the previous
239238summary plugin have been preserved in the tallies plugin.
240239
241240The plugin now attempts to determine a declared license expression, holder, and
242- primary programming language from a scan. The license clarity score is provided
241+ primary programming language from a scan. The license clarity score provides
243242context on what origin information is provided from key files. It also returns
244243lists of tallies of the other detected license expressions, holders, and
245244programming languages. All information is provided in the codebase level
@@ -249,7 +248,7 @@ attribute named ``summary``.
249248Outputs:
250249~~~~~~~~
251250
252- - Add new outputs for the CycloneDx format.
251+ - Added new outputs for the CycloneDx format.
253252 The CLI now exposes options to produce CycloneDx BOMs in either JSON or XML format
254253
255254 - A new field ``warnings `` has been added to the headers of ScanCode toolkit output
@@ -273,7 +272,7 @@ Changes:
273272Documentation Update
274273~~~~~~~~~~~~~~~~~~~~~~~~
275274
276- - Various documentations have been updated to reflects API changes and
275+ - Various documentation files have been updated to reflects API changes and
277276 correct minor documentation issues.
278277
279278
@@ -285,7 +284,7 @@ Development environment changes:
285284 instead the --reindex-licenses option to rebuild the license index.
286285
287286- We can now regenerate updated test fixtures using the new SCANCODE_REGEN_TEST_FIXTURES
288- environemnt variable. There is no need to replace the regen=False with regen=True
287+ environment variable. There is no need to replace the regen=False with regen=True
289288 in the code.
290289
291290
0 commit comments