From c3283ec9235a03cf954da37be950370cbc36a8c7 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 13 Aug 2024 18:21:25 +0100 Subject: [PATCH] Fix HTTP casing + update links to license-list-XML repo - Use "HTTP" and "HTTPS" for protocol names - Use "http://" and "https://" for URI schemes of URL - Use "SPDX License List" caps style as it is a proper noun and stylized like that consistently in https://spdx.org/licenses/ - Keep page title and navigation bar title match - Use a versioned link of resources from license-list-XML repo Signed-off-by: Arthit Suriyawongkul --- ...cense-matching-guidelines-and-templates.md | 25 ++++++++++++------- mkdocs.yml | 2 +- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/annexes/license-matching-guidelines-and-templates.md b/docs/annexes/license-matching-guidelines-and-templates.md index de3999242f..dcb78d9bd9 100644 --- a/docs/annexes/license-matching-guidelines-and-templates.md +++ b/docs/annexes/license-matching-guidelines-and-templates.md @@ -1,6 +1,6 @@ -# SPDX License List Matching Guidelines and Templates (Normative) +# SPDX License List matching guidelines and templates (Normative) -## SPDX license list matching guidelines +## SPDX License List matching guidelines The SPDX License List Matching Guidelines provide guidelines to be used for the purposes of matching licenses and license exceptions against those included on the [SPDX License List](https://spdx.org/licenses/). There is no intent here to make a judgment or interpretation, but merely to ensure that when one SPDX user identifies a license as "BSD-3-Clause," for example, it is indeed the same license as what someone else identifies as "BSD-3-Clause" and the same license as what is listed on the SPDX License List. @@ -14,7 +14,7 @@ To ensure consistent results by different SPDX document creators when matching l ### Guideline: official license headers -The matching guidelines apply to license and exception text, as well as official license headers. Official license headers are defined by the SPDX License List as specific text specified within the license itself to be put in the header of files. (see [explanation of SPDX License List fields](https://github.com/spdx/license-list-XML/blob/master/DOCS/license-fields.md) for more info). +The matching guidelines apply to license and exception text, as well as official license headers. Official license headers are defined by the SPDX License List as specific text specified within the license itself to be put in the header of files. (see [explanation of SPDX License List fields](https://github.com/spdx/license-list-XML/blob/v3.24.0/DOCS/license-fields.md) for more info). The following XML tag is used to implement this guideline: `` @@ -213,28 +213,35 @@ Ignore any text that occurs after the obvious end of the license and does not in To implement this guideline, use the `` XML element tag as described in [Guideline: omittable text](#C.3.5). -## HTTP Protocol +## HTTP protocol ### Purpose -To avoid a license mismatch due to a difference in a hyperlink protocol (e.g. http vs. https). +To avoid a license mismatch due to a difference in a hyperlink protocol (e.g. HTTP vs. HTTPS). ### Guideline -HTTP:// and HTTPS:// should be considered equivalent. +`http://` and `https://` should be considered equivalent. XML files do not require specific markup to implement this guideline. -## SPDX License list +## SPDX License List ### Template access -The license XML can be accessed in the license-list-data repository under the license-list-XML directory. Although the license list XML files can also be found in the [license-list-XML](https://github.com/spdx/license-list-XML) repository, users are encouraged to use the published versions in the [license-list-data](https://github.com/spdx/license-list-data) repository. The license-list-data repository is tagged by release. Only tagged released versions of the license list are considered stable. +The license XML can be accessed in the license-list-data repository under the +license-list-XML directory. Although the license list XML files can also be +found in the +[license-list-XML](https://github.com/spdx/license-list-XML) repository, +users are encouraged to use the published versions in the +[license-list-data](https://github.com/spdx/license-list-data) repository. +The license-list-data repository is tagged by release. +Only tagged released versions of the license list are considered stable. ### License List XML format A full schema for the License List XML can be found at -[SPDX License List XML Schema](https://github.com/spdx/license-list-XML/blob/master/schema/ListedLicense.xsd). +[SPDX License List XML Schema](https://github.com/spdx/license-list-XML/blob/v3.24.0/schema/ListedLicense.xsd). ### Legacy Text Template format diff --git a/mkdocs.yml b/mkdocs.yml index 1dc1c63a4d..7272c70894 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,7 +44,7 @@ nav: - 'A. Changes from the previous standard': annexes/changes-from-previous-iso.md - 'B. RDF model definition and diagrams': annexes/rdf-model.md - 'C. SPDX license expressions': annexes/spdx-license-expressions.md - - 'D. SPDX license list matching guidelines': annexes/license-matching-guidelines-and-templates.md + - 'D. SPDX License List matching guidelines': annexes/license-matching-guidelines-and-templates.md - 'E. SPDX Lite': annexes/spdx-lite.md - 'F. Package URL specification': annexes/pkg-url-specification.md - 'G. History with OMG': omg-history.md