Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SPDX 2.3: Update required licensing fields to optional #1180

Open
rnjudge opened this issue Jun 27, 2022 · 0 comments
Open

SPDX 2.3: Update required licensing fields to optional #1180

rnjudge opened this issue Jun 27, 2022 · 0 comments
Labels
spdx Issues related to the SPDX formatting of Tern reports
Milestone

Comments

@rnjudge
Copy link
Contributor

rnjudge commented Jun 27, 2022

Description
A change to the SPDX 2.3 spec made currently required licensing fields optional.

To Do
The omission of these fields, by default, now assumes a NOASSERTION value. If we want to make some of the generated docs shorter, we can omit these fields if they have a NOASSERTION value. The following fields can be excluded from generated documents if they don't have a valid license/copyright value:

Package Concluded license - 7.13  # 99.99% NOASSERTION in Tern generated docs. We can exclude in this case.
Package Declared license - 7.15  # Usually a license value is provide. If NOASSERTION, though, we can exclude listing it.
Package Copyright text - 7.17 
File Concluded license - 8.5
License information in file - 8.6
File Copyright text - 8.8
Snippet Concluded license - 9.5
Snippet Copyright text - 9.8

To implement this change, we should check if a value is provided by these object descriptors. If not, do not list the field instead of printing NOASSERTION as the value.

Background
List issues for background on the task

@rnjudge rnjudge added this to the Near Future milestone Jun 27, 2022
@rnjudge rnjudge added the spdx Issues related to the SPDX formatting of Tern reports label Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spdx Issues related to the SPDX formatting of Tern reports
Projects
None yet
Development

No branches or pull requests

1 participant