Skip to content

Commit baf5641

Browse files
committed
Organize annexes
Updates the annex ordering. Closes spdx#478 Signed-off-by: Rose Judge <rose.judge@broadcom.com>
1 parent 3b3521d commit baf5641

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

docs/annexes/diffs-from-previous-editions.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Annex I Differences from previous editions (Informative)
1+
# Annex A: Differences from previous editions (Informative)
22

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

55
## Structural Differences
66

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

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

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

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

@@ -821,7 +821,7 @@ Key changes include:
821821

822822
* 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.
823823

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

826826
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.
827827

@@ -837,7 +837,7 @@ Key changes include:
837837

838838
* 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:
839839

840-
**Table I.1 — SPDX V2.2.2 Organizational Changes**
840+
**Table A.1 — SPDX V2.2.2 Organizational Changes**
841841

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

849849
*_This edition featured inconsistent lettering._
850850

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

853853
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:
854854

855-
**Table I.2 — SPDX V2.2.1 Organizational Changes**
855+
**Table A.2 — SPDX V2.2.1 Organizational Changes**
856856

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

884884
*_This edition featured inconsistent lettering._
885885

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

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

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

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

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

900900
* 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.
901901

@@ -910,7 +910,7 @@ more information.
910910

911911
* Miscellaneous bug fixes.
912912

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

915915
* 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-”.
916916

docs/annexes/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Annex J: Getting started writing SPDX 3 (Informative)
1+
# Annex B: Getting started writing SPDX 3 (Informative)
22
## (a.k.a My First SPDX File)
33

44
This guide is designed to walk you through the concepts behind an SPDX

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -330,14 +330,14 @@ nav:
330330
- model/Extension/Properties/cdxPropValue.md
331331
- model/Extension/Properties/cdxProperty.md
332332
- annexes:
333+
- 'Diffs from Previous Editions': annexes/diffs-from-previous-editions.md
334+
- 'Getting started with SPDX 3': annexes/getting-started.md
333335
- 'RDF Object Model and Identifier Syntax': annexes/RDF-object-model-and-identifier-syntax.md
334336
- 'SPDX License Expressions': annexes/SPDX-license-expressions.md
335337
- 'Using SPDX short identifiers in Source Files': annexes/using-SPDX-short-identifiers-in-source-files.md
336338
- 'Using SPDX to comply with norms, standards and regulation': annexes/using-SPDX-to-comply-with-industry-guidance.md
337339
- 'Including Security Information in SPDX': annexes/including-security-information-in-SPDX.md
338340
- 'SPDX Lite': annexes/SPDX-Lite.md
339-
- 'Diffs from Previous Editions': annexes/diffs-from-previous-editions.md
340-
- 'Getting started with SPDX 3': annexes/getting-started.md
341341
- licenses:
342342
- 'Creative Commons Attribution License 3.0 Unported': licenses/CC-BY-3.0.md
343343
- 'Community Specification License 1.0': licenses/Community-Spec-1.0.md

0 commit comments

Comments
 (0)