Skip to content

Commit

Permalink
Use H2 for headings
Browse files Browse the repository at this point in the history
To allow readthedocs to generate proper heading items in the navigation bar.

In Markdown, H1 is reserved for the title.
readthedocs theme will read only H2 headings to generate expandable items in the nav bar.

There is no change in the content.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
  • Loading branch information
bact authored and goneall committed Aug 9, 2024
1 parent 5c893ae commit ed8c9b5
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions chapters/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)

# I.1 Differences between V2.3 and V2.2.2 <a name="I.1"></a>
## I.1 Differences between V2.3 and V2.2.2 <a name="I.1"></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 @@ -24,9 +24,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.2 Differences between V2.2.2 and V2.2.1 <a name="I.2"></a>
## I.2 Differences between V2.2.2 and V2.2.1 <a name="I.2"></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 @@ -53,7 +51,7 @@ Creative Commons Attribution License 3.0 Unported | Annex G | [omitted] | Ann

*_This edition featured inconsistent lettering._

# I.3 Differences between V2.2.1 and V2.2 <a name="I.3"></a>
## I.3 Differences between V2.2.1 and V2.2 <a name="I.3"></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:

Expand Down Expand Up @@ -85,10 +83,9 @@ SPDX Lite | Appendix VIII | Annex H/G* |
SPDX File Tags | Appendix IX | Annex I/H* | Annex H
Differences from Earlier SPDX Versions | N/A | Annex J/I* | Annex I


*_This edition featured inconsistent lettering._

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

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

Expand All @@ -100,7 +97,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.5 Differences between V2.1 and V2.0 <a name="I.5"></a>
## I.5 Differences between V2.1 and V2.0 <a name="I.5"></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 @@ -115,7 +112,7 @@ more information.

* Miscellaneous bug fixes.

# I.6 Differences between V2.0 and V1.2 <a name="I.6"></a>
## I.6 Differences between V2.0 and V1.2 <a name="I.6"></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

0 comments on commit ed8c9b5

Please sign in to comment.