Merge pull request #2548 from akugarg/add_new_flag

Add new flag in License Data Model definition

Author: pombredanne

CHANGELOG.rst

@@ -43,6 +43,25 @@ Package detection:
  - Add support to track installed files for each Package type.
 
 
+License detection:
+~~~~~~~~~~~~~~~~~~~
+
+- Unknown licenses have a new flag "is_unknown" to identify them
+  beyond just the naming convention of having "unknown" as part of their name.
+
+- Rules that match at least one unknown license have a flag "has_unknown" set
+  in the returned match results.
+
+
+Many thanks to every contributors that made this possible and in particular:
+
+- Akanksha Garg @akugarg
+- Ayan Sinha Mahapatra @AyanSinhaMahapatra
+- Jono Yang @JonoYang
+- Philippe Ombredanne @pombredanne
+
+
+
 v21.8.4
 ---------
 

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

@@ -177,6 +177,7 @@ following options.
               "short_name": "MIT Old Style",
               "category": "Permissive",
               "is_exception": false,
+              "is_unknown": false,
               "owner": "MIT",
               "homepage_url": "http://fedoraproject.org/wiki/Licensing:MIT#Old_Style",
               "text_url": "http://fedoraproject.org/wiki/Licensing:MIT#Old_Style",

docs/source/cli-reference/synopsis.rst

@@ -228,6 +228,7 @@ A sample JSON output for an individual file will look like::
           "short_name": "MIT Old Style",
           "category": "Permissive",
           "is_exception": false,
+          "is_unknown": false,
           "owner": "MIT",
           "homepage_url": "http://fedoraproject.org/wiki/Licensing:MIT#Old_Style",
           "text_url": "http://fedoraproject.org/wiki/Licensing:MIT#Old_Style",

src/licensedcode/data/licenses/free-unknown.yml

@@ -3,4 +3,6 @@ short_name: Free unknown
 name: Free unknown license detected but not recognized
 category: Unstated License
 owner: Unspecified
+is_unknown: yes
 spdx_license_key: LicenseRef-scancode-free-unknown
+

src/licensedcode/data/licenses/license-file-reference.yml

@@ -4,4 +4,5 @@ short_name: license-file-reference
 name: license-file-reference
 category: Unstated License
 owner: Unspecified
+is_unknown: yes
 notes: this was known before as "see-license" and is now unknown-license-reference

src/licensedcode/data/licenses/see-license.yml

@@ -4,4 +4,5 @@ name: See License mention
 category: Unstated License
 owner: Unspecified
 is_deprecated: yes
+is_unknown: yes
 notes: replaced by unknown-license-reference

src/licensedcode/data/licenses/unknown-license-reference.yml

@@ -3,6 +3,7 @@ short_name: Unknown License reference
 name: Unknown License file reference
 category: Unstated License
 owner: Unspecified
+is_unknown: yes
 notes: This is reference to a license file with no clear license. this was known before as "see-license"
     and "license-file-reference"
 spdx_license_key: LicenseRef-scancode-unknown-license-reference

src/licensedcode/data/licenses/unknown-spdx.yml

@@ -3,6 +3,7 @@ short_name: unknown SPDX
 name: Unknown SPDX license detected but not recognized
 category: Unstated License
 owner: Unspecified
+is_unknown: yes
 spdx_license_key: LicenseRef-scancode-unknown-spdx
 notes: This is something that clearly ressembles a license in an SPDX license
  expression but is not conclusively an SPDX license ID.

src/licensedcode/data/licenses/unknown.yml

@@ -3,5 +3,6 @@ short_name: unknown
 name: Unknown license detected but not recognized
 category: Unstated License
 owner: Unspecified
+is_unknown: yes
 spdx_license_key: LicenseRef-scancode-unknown
 notes: This is something that clearly ressembles a license but is not conclusive.

src/licensedcode/data/rules/unknown_german_1.yml

@@ -1,3 +1,3 @@
 license_expression: unknown
 is_license_reference: yes
-notes: in german
+notes: in german