Skip to content

Commit

Permalink
Organize annexes
Browse files Browse the repository at this point in the history
Updates the annex ordering.

Closes spdx#478

Signed-off-by: Rose Judge <[email protected]>
  • Loading branch information
rnjudge committed Apr 14, 2024
1 parent 3b3521d commit baf5641
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
20 changes: 10 additions & 10 deletions docs/annexes/diffs-from-previous-editions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Annex I Differences from previous editions (Informative)
# Annex A: Differences from previous editions (Informative)

# I.1 Differences between V3.0 and V2.3 <a name="I.1"></a>
# A.1 Differences between V3.0 and V2.3 <a name="A.1"></a>

## Structural Differences

Expand Down Expand Up @@ -797,7 +797,7 @@ The Tag/Value, YAML, RDF/XML and Spreadsheet formats are not supported.

Additional serialization formats are being considered for the SPDX 3.1 release.

# I.2 Differences between V2.3 and V2.2.2 <a name="I.2"></a>
# A.2 Differences between V2.3 and V2.2.2 <a name="A.2"></a>

V2.3 has added new fields to improve the ability to capture security related information and to improve interoperabiility with other SBOM formats.

Expand All @@ -821,7 +821,7 @@ Key changes include:

* Added Annex K ( How To Use SPDX in Different Scenarios ) to illustrate linking to external security information, and illustrate how the NTIA SBOM mandatory minimum elements map to SPDX fields.

# I.3 Differences between V2.2.2 and V2.2.1 <a name="I.3"></a>
# A.3 Differences between V2.2.2 and V2.2.1 <a name="A.3"></a>

V2.2.2 fixed formatting, grammatical and spelling issues found since ISO/IEC 5962:2021 SPDX v2.2.1 was published. No new fields were added.

Expand All @@ -837,7 +837,7 @@ Key changes include:

* It fixed annex lettering inconsistencies. It also moved CC-BY-3.0 to the end of the spec to keep annex letters more consistent in future versions. Here is the translation between lettering in V2.2.2 and the version that came before it:

**Table I.1 — SPDX V2.2.2 Organizational Changes**
**Table A.1 — SPDX V2.2.2 Organizational Changes**

Title | V2.2.1 ([spdx.dev](https://spdx.dev/)) | V2.2.1 (ISO) | V2.2.2
----- | -------------------------------------- | ------------ | ------
Expand All @@ -848,11 +848,11 @@ Creative Commons Attribution License 3.0 Unported | Annex G | [omitted] | Ann

*_This edition featured inconsistent lettering._

# I.4 Differences between V2.2.1 and V2.2 <a name="I.4"></a>
# A.4 Differences between V2.2.1 and V2.2 <a name="A.4"></a>

There were no technical differences; V2.2.1 is V2.2 reformatted for submission to ISO via the PAS process. As a result, new clauses were added causing the previous clause-numbering sequence to change. Also, Annexes went from having Roman numbers to Latin letters. Here is the translation between numbering in V2.2.1 and the version that came before it:

**Table I.2 — SPDX V2.2.1 Organizational Changes**
**Table A.2 — SPDX V2.2.1 Organizational Changes**

Title | V2.2 | V2.2.1 ([spdx.dev](https://spdx.dev/)) | V2.2.1 (ISO)
----- | --------- | -------------------------------------- | ------------
Expand Down Expand Up @@ -883,7 +883,7 @@ Differences from Earlier SPDX Versions | N/A | Annex J/I* |

*_This edition featured inconsistent lettering._

# I.5 Differences from V2.2 and V2.1 <a name="I.5"></a>
# A.5 Differences from V2.2 and V2.1 <a name="A.5"></a>

* JSON, YAML, and a development version of XML have been added as supported file formats.

Expand All @@ -895,7 +895,7 @@ Differences from Earlier SPDX Versions | N/A | Annex J/I* |

* Miscellaneous bug fixes and non-breaking improvements as reported on the mailing list and reported as issues on the spdx-spec GitHub repository.

# I.6 Differences between V2.1 and V2.0 <a name="I.6"></a>
# A.6 Differences between V2.1 and V2.0 <a name="A.6"></a>

* Snippets have been added to allow a portion of a file to be identified as having different properties from the file it resides in. The use of snippets is completely optional and it is not mandatory for snippets to be identified. See section 5 Snippet Information for further details on the fields available to describe snippets.

Expand All @@ -910,7 +910,7 @@ more information.

* Miscellaneous bug fixes.

# I.7 Differences between V2.0 and V1.2 <a name="I.7"></a>
# A.7 Differences between V2.0 and V1.2 <a name="A.7"></a>

* Abstraction has been applied to the underlying model with the inclusion of SPDX elements. With SPDX 2.0, the concept of an SPDX element is introduced (see Appendix III). This includes SPDX documents, SPDX files, and SPDX packages, each of which gets associated with an SPDX identifier which is denoted by “SPDXRef-”.

Expand Down
2 changes: 1 addition & 1 deletion docs/annexes/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Annex J: Getting started writing SPDX 3 (Informative)
# Annex B: Getting started writing SPDX 3 (Informative)
## (a.k.a My First SPDX File)

This guide is designed to walk you through the concepts behind an SPDX
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -330,14 +330,14 @@ nav:
- model/Extension/Properties/cdxPropValue.md
- model/Extension/Properties/cdxProperty.md
- annexes:
- 'Diffs from Previous Editions': annexes/diffs-from-previous-editions.md
- 'Getting started with SPDX 3': annexes/getting-started.md
- 'RDF Object Model and Identifier Syntax': annexes/RDF-object-model-and-identifier-syntax.md
- 'SPDX License Expressions': annexes/SPDX-license-expressions.md
- 'Using SPDX short identifiers in Source Files': annexes/using-SPDX-short-identifiers-in-source-files.md
- 'Using SPDX to comply with norms, standards and regulation': annexes/using-SPDX-to-comply-with-industry-guidance.md
- 'Including Security Information in SPDX': annexes/including-security-information-in-SPDX.md
- 'SPDX Lite': annexes/SPDX-Lite.md
- 'Diffs from Previous Editions': annexes/diffs-from-previous-editions.md
- 'Getting started with SPDX 3': annexes/getting-started.md
- licenses:
- 'Creative Commons Attribution License 3.0 Unported': licenses/CC-BY-3.0.md
- 'Community Specification License 1.0': licenses/Community-Spec-1.0.md

0 comments on commit baf5641

Please sign in to comment.