Skip to content

Commit 1a98be4

Browse files
committed
Update SPDX-2.1 references to SPDX-2.2
This commit updates Tern documentation to reflect the current version of the SPDX spec, SPDX-2.2. Signed-off-by: Marc-Etienne Vargenau <[email protected]> Signed-off-by: Rose Judge <[email protected]>
1 parent bebfe62 commit 1a98be4

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/project-roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88

99
We will also continue to work on the following:
10-
- We will continue to support the SPDX format for container images. To that end, we will make changes to update the format of the document as the [spec](https://spdx.org/sites/cpstandard/files/pages/files/spdxversion2.1.pdf) evolves.
10+
- We will continue to support the SPDX format for container images. To that end, we will make changes to update the format of the document as the [spec](https://spdx.github.io/spdx-spec/) evolves.
1111
- As usual, we will continue to work on our technical debt and bug fixes.
1212

1313
This timetable is based on time, resources and feedback from you and will change accordingly.

docs/spdx-tag-value-mapping.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,29 @@ This file describes a potential mapping between Tern's data structures and the r
66

77
In particular, it will focus on highlighting any necessary data items that are deemed "mandatory" by the SPDX specification.
88

9-
Version 2.1 of [the SPDX specification](https://spdx.org/specifications) will be used, since it is the most recent minor release. Relevant details of the SPDX tag-value format can be found in [the overview document](spdx-tag-value-overview.md) in this directory.
9+
Version 2.2 of [the SPDX specification](https://spdx.org/specifications) will be used, since it is the most recent minor release. Relevant details of the SPDX tag-value format can be found in [the overview document](spdx-tag-value-overview.md) in this directory.
1010

1111
## Relevant Fields
1212

1313
The following table contains (1) all fields that are designated by the SPDX specification as 'mandatory', for the SPDX elements that Tern is likely to use; and (2) any additional fields that are optional but likely to be useful for Tern.
1414

1515
Thoughts on mapping these fields to Tern's data model are described in the **Mapping** section below.
1616

17-
Section (§) numbers are references to the relevant portions of [the SPDX specification](https://spdx.org/specifications), version 2.1. Examples should be assumed to be on a single line, though a Markdown formatter might split them across lines.
17+
Section (§) numbers are references to the relevant portions of [the SPDX specification](https://spdx.org/specifications), version 2.2. Examples should be assumed to be on a single line, though a Markdown formatter might split them across lines.
1818

1919
### Document Creation
2020

2121
The following fields should appear *once*, at the beginning of the SPDX document:
2222

2323
§ | SPDX Field name | Mandatory? | Brief description | Example
2424
----|-----------------|------------|----------------------|---------
25-
2.1 | SPDX Version | Yes | version of SPDX spec | `SPDXVersion: SPDX-2.1`
25+
2.1 | SPDX Version | Yes | version of SPDX spec | `SPDXVersion: SPDX-2.2`
2626
2.2 | Data License | Yes | license for SPDX metadata in the document itself; always `CC0-1.0` | `DataLicense: CC0-1.0`
2727
2.3 | SPDX Identifier | Yes | identifier for the SPDX document itself; always `SPDXRef-DOCUMENT` | `SPDXID: SPDXRef-DOCUMENT`
2828
2.4 | Document Name | Yes | human-readable name for the SPDX document itself | `DocumentName: Tern report for ACME Dockerfile`
2929
2.5 | SPDX Document Namespace | Yes| unique absolute URI for the SPDX document itself | `DocumentNamespace: https://example.com/spdxdocs/tern-report-ACME-1.0.1-123456`
30-
2.7 | License List Version | No | release version of the SPDX License List being used | `LicenseListVersion: 3.4`
31-
2.8 | Creator | Yes | one or more people, orgs or tools used to create the SPDX document | `Creator: Tool: tern-0.4.0`
30+
2.7 | License List Version | No | release version of the SPDX License List being used | `LicenseListVersion: 3.16`
31+
2.8 | Creator | Yes | one or more people, orgs or tools used to create the SPDX document | `Creator: Tool: tern-2.10`
3232
2.9 | Created | Yes | the time and date when the SPDX document was created (ISO 8601; UTC) | `Created: 2019-03-15T08:25:00Z`
3333

3434
### Package
@@ -84,7 +84,7 @@ Include once at the beginning of the SPDX document.
8484

8585
§ | SPDX Field name | Tern data model reference | Comments
8686
----|-----------------|---------------------------|---------
87-
2.1 | SPDX Version | N/A | will always be `SPDXVersion: SPDX-2.1`
87+
2.1 | SPDX Version | N/A | will always be `SPDXVersion: SPDX-2.2`
8888
2.2 | Data License | N/A | will always be `DataLicense: CC0-1.0`
8989
2.3 | SPDX Identifier | N/A | will always be `SPDXID: SPDXRef-DOCUMENT`
9090
2.4 | Document Name | **TBD** | does Tern have a human-readable way to refer to the image or Dockerfile being analyzed?

docs/spdx-tag-value-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ An SPDX document consists of a series of colon-separateed tag/value pairs, one p
1515
For example, the following tag-value pairs define the version of [the SPDX specification](https://spdx.org/specifications) that is used by the document, and a name for the SPDX document:
1616

1717
```
18-
SPDXVersion: SPDX-2.1
18+
SPDXVersion: SPDX-2.2
1919
DocumentName: Tern report for Acme Dockerfile
2020
```
2121

tern/formats/spdx/spdx_common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ def get_layer_spdxref_snapshot(timestamp):
9494
def get_layer_verification_code(layer_obj):
9595
'''Calculate the verification code from the files in an image layer. This
9696
assumes that layer_obj.files_analyzed is True. The implementation follows
97-
the algorithm in the SPDX spec v 2.1 which requires SHA1 to be used to
97+
the algorithm in the SPDX spec v 2.2 which requires SHA1 to be used to
9898
calculate the checksums of the file and the final verification code'''
9999
sha1_list = []
100100
for filedata in layer_obj.files:

0 commit comments

Comments
 (0)