From 650860a9886d7d8569bb769ecadee3609ebed183 Mon Sep 17 00:00:00 2001 From: BassCoder2808 Date: Tue, 7 Mar 2023 23:28:39 +0530 Subject: [PATCH 1/4] Removed isDeprecated from xml-field documentation --- DOCS/xml-fields.md | 58 +++++++++++++++++++++++++--------------------- 1 file changed, 31 insertions(+), 27 deletions(-) diff --git a/DOCS/xml-fields.md b/DOCS/xml-fields.md index 60771b90c..2f6dcef55 100644 --- a/DOCS/xml-fields.md +++ b/DOCS/xml-fields.md @@ -44,17 +44,19 @@ Within the .xml file, the first and last lines of the file should be the followi The main tag used to define the license or exception is, unsurprisingly, **``** or **``**. All of the remaining content will be enclosed within a `` or `` pair of tags. There are two mandatory attributes for every `` and `` tag: -* `licenseId`: the unique SPDX Identifier for the license; should be identical to the filename -* `name`: the longer "real name" of the license + +- `licenseId`: the unique SPDX Identifier for the license; should be identical to the filename +- `name`: the longer "real name" of the license There are two additional attributes which are optional, but highly encouraged: -* `isOsiApproved` (for licenses, not exceptions): either "true" or "false" based on whether this license has been approved by the [Open Source Initiative](https://opensource.org/licenses/alphabetical) -* `listVersionAdded`: in which release version of the SPDX License List was the license first added, e.g. "3.19". - * Typically you'll check the currently-released version at https://spdx.org/licenses/ and increment the minor version by 1 for a new license. + +- `isOsiApproved` (for licenses, not exceptions): either "true" or "false" based on whether this license has been approved by the [Open Source Initiative](https://opensource.org/licenses/alphabetical) +- `listVersionAdded`: in which release version of the SPDX License List was the license first added, e.g. "3.19". + - Typically you'll check the currently-released version at https://spdx.org/licenses/ and increment the minor version by 1 for a new license. Finally, if the license ID has been deprecated, two additional attributes should be included: -* `isDeprecated`: should be "true" if the license ID is deprecated -* `deprecatedVersion`: in which release version of the SPDX License List was the license first marked as deprecated, e.g. "3.19" + +- `deprecatedVersion`: in which release version of the SPDX License List was the license first marked as deprecated, e.g. "3.19" Note that the deprecated tags refer to whether the ID has been deprecated _by SPDX_ -- in other words, if the SPDX Legal Team no longer recommends that the identifier should be used. Licenses that have been described as "deprecated" or "superseded" by the _license author_ might no longer be recommended to use for new code, but their identifiers remain valid License IDs on the SPDX License List. @@ -64,15 +66,15 @@ Deprecated license identifiers will be listed at the bottom of the SPDX License There are three optional first-level metadata fields that can be nested immediately under `` or ``, each of which is optional: -* **``**: Defines cross-references to URLs where the license can be found in use by one or a few projects, and (if applicable) where posted by the license steward -* **``**: Describes general comments about the license; if deprecated, also briefly explain the reason for deprecating the license identifier -* **``** (if license is deprecated): Lists the license(s) that should be used instead of this deprecated license +- **``**: Defines cross-references to URLs where the license can be found in use by one or a few projects, and (if applicable) where posted by the license steward +- **``**: Describes general comments about the license; if deprecated, also briefly explain the reason for deprecating the license identifier +- **``** (if license is deprecated): Lists the license(s) that should be used instead of this deprecated license ### License text Then, the actual license text would be contained within the `` section: -* **``**: Defines the actual text and templating for the license +- **``**: Defines the actual text and templating for the license Example: @@ -95,12 +97,12 @@ Example: Some portions of the license text can be surrounded by annotation tags, to denote certain sections of the license text: -* **``**: indicates the title of the license, if specified in the license text itself -* **``**: indicates where a copyright notice would be placed for the licensed code - * Note that `` should _not_ be used for copyright notices that apply to the copyright in the license text itself! -* **``**: indicates a standard way that the license recommends specifying the license, e.g. in code comments - * Note that `` should _only_ be used if it is defined by the license text itself! - * Typically, this would be located in an appendix titled something like "How to apply the license to your work" +- **``**: indicates the title of the license, if specified in the license text itself +- **``**: indicates where a copyright notice would be placed for the licensed code + - Note that `` should _not_ be used for copyright notices that apply to the copyright in the license text itself! +- **``**: indicates a standard way that the license recommends specifying the license, e.g. in code comments + - Note that `` should _only_ be used if it is defined by the license text itself! + - Typically, this would be located in an appendix titled something like "How to apply the license to your work" ### Paragraphs and newlines @@ -116,11 +118,11 @@ Numbered lists (e.g., a series of numbered sections) and unnumbered lists (e.g., Here are the basic rules: -* The list as a whole should be surrounded with **`...`** tags. -* Within the ``, each item in the list should be surrounded with **`...`** tags. -* If a list item has a section number or a bullet point at the start, the section number or bullet should be surrounded with **`...`** tags. -* Sub-lists can be nested within an item, to indicate e.g. subsections within an overarching numbered section. -* Items can also contain **`

...

`** tags, as needed if an item contains multiple paragraphs. +- The list as a whole should be surrounded with **`...`** tags. +- Within the ``, each item in the list should be surrounded with **`...`** tags. +- If a list item has a section number or a bullet point at the start, the section number or bullet should be surrounded with **`...`** tags. +- Sub-lists can be nested within an item, to indicate e.g. subsections within an overarching numbered section. +- Items can also contain **`

...

`** tags, as needed if an item contains multiple paragraphs. Example: @@ -165,15 +167,17 @@ Note that some annotated portions of text (specifically `` and `...`** tag. The **** tag includes two attributes: -* `name`: specifies a unique name for this matching element -* `match`: specifies a [POSIX extended regular expression (ERE)](http://pubs.opengroup.org/onlinepubs/9699919799/) for what text will match + +- `name`: specifies a unique name for this matching element +- `match`: specifies a [POSIX extended regular expression (ERE)](http://pubs.opengroup.org/onlinepubs/9699919799/) for what text will match Note that an example of actually-matching text should be included between the `` and `` tags, as the specified example is what will be rendered on the SPDX License List website page and in license text files provided by SPDX. To the extent a license has a "canonical" or "most commonly used" standard language, use that in the match between the `alt` tags. Learning regular expressions is outside the scope of this document. However, here are a few of the most common patterns, taken from [BSD-3-Clause](../src/BSD-3-Clause.xml) which is a good example of using several `` tags effectively: -* `are`: Matches if the text is either the word "are" or the word "is" -* `EXPRESS`: Matches if the text is either the word "EXPRESS" or the word "EXPRESSED" -* `THE COPYRIGHT HOLDERS AND CONTRIBUTORS`: Matches anything as long as it consists of at least one or more characters + +- `are`: Matches if the text is either the word "are" or the word "is" +- `EXPRESS`: Matches if the text is either the word "EXPRESS" or the word "EXPRESSED" +- `THE COPYRIGHT HOLDERS AND CONTRIBUTORS`: Matches anything as long as it consists of at least one or more characters ### Other things to watch out for From 16a9a6400b67668421f83606362c77368c5b49e5 Mon Sep 17 00:00:00 2001 From: BassCoder2808 Date: Tue, 7 Mar 2023 23:29:29 +0530 Subject: [PATCH 2/4] Removed isDeprecated from the xml format itself --- schema/ListedLicense.xsd | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/schema/ListedLicense.xsd b/schema/ListedLicense.xsd index a4aa45ce1..48ce5266c 100644 --- a/schema/ListedLicense.xsd +++ b/schema/ListedLicense.xsd @@ -48,7 +48,6 @@ - @@ -110,15 +109,6 @@ - - - - - isDeprecated is true if and only if the short identifier has been superseded by another. See the deprecatedVersion documentation for more details. - - - - From 5cc8a0cc7245701355bba404b63475afe1bacda3 Mon Sep 17 00:00:00 2001 From: BassCoder2808 Date: Wed, 8 Mar 2023 23:03:06 +0530 Subject: [PATCH 3/4] Chnaged the defination from 2 additional to 1 --- DOCS/xml-fields.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCS/xml-fields.md b/DOCS/xml-fields.md index 2f6dcef55..566ab9611 100644 --- a/DOCS/xml-fields.md +++ b/DOCS/xml-fields.md @@ -54,7 +54,7 @@ There are two additional attributes which are optional, but highly encouraged: - `listVersionAdded`: in which release version of the SPDX License List was the license first added, e.g. "3.19". - Typically you'll check the currently-released version at https://spdx.org/licenses/ and increment the minor version by 1 for a new license. -Finally, if the license ID has been deprecated, two additional attributes should be included: +Finally, if the license ID has been deprecated, one additional attribute should be included: - `deprecatedVersion`: in which release version of the SPDX License List was the license first marked as deprecated, e.g. "3.19" From 82cad8a1609874ade01312a1893ae6366396daeb Mon Sep 17 00:00:00 2001 From: BassCoder2808 Date: Wed, 8 Mar 2023 23:14:09 +0530 Subject: [PATCH 4/4] Changed the - to * for md file --- DOCS/xml-fields.md | 57 +++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 31 deletions(-) diff --git a/DOCS/xml-fields.md b/DOCS/xml-fields.md index 566ab9611..72fb1ad48 100644 --- a/DOCS/xml-fields.md +++ b/DOCS/xml-fields.md @@ -44,19 +44,16 @@ Within the .xml file, the first and last lines of the file should be the followi The main tag used to define the license or exception is, unsurprisingly, **``** or **``**. All of the remaining content will be enclosed within a `` or `` pair of tags. There are two mandatory attributes for every `` and `` tag: - -- `licenseId`: the unique SPDX Identifier for the license; should be identical to the filename -- `name`: the longer "real name" of the license +* `licenseId`: the unique SPDX Identifier for the license; should be identical to the filename +* `name`: the longer "real name" of the license There are two additional attributes which are optional, but highly encouraged: - -- `isOsiApproved` (for licenses, not exceptions): either "true" or "false" based on whether this license has been approved by the [Open Source Initiative](https://opensource.org/licenses/alphabetical) -- `listVersionAdded`: in which release version of the SPDX License List was the license first added, e.g. "3.19". - - Typically you'll check the currently-released version at https://spdx.org/licenses/ and increment the minor version by 1 for a new license. +* `isOsiApproved` (for licenses, not exceptions): either "true" or "false" based on whether this license has been approved by the [Open Source Initiative](https://opensource.org/licenses/alphabetical) +* `listVersionAdded`: in which release version of the SPDX License List was the license first added, e.g. "3.19". + * Typically you'll check the currently-released version at https://spdx.org/licenses/ and increment the minor version by 1 for a new license. Finally, if the license ID has been deprecated, one additional attribute should be included: - -- `deprecatedVersion`: in which release version of the SPDX License List was the license first marked as deprecated, e.g. "3.19" +* `deprecatedVersion`: in which release version of the SPDX License List was the license first marked as deprecated, e.g. "3.19" Note that the deprecated tags refer to whether the ID has been deprecated _by SPDX_ -- in other words, if the SPDX Legal Team no longer recommends that the identifier should be used. Licenses that have been described as "deprecated" or "superseded" by the _license author_ might no longer be recommended to use for new code, but their identifiers remain valid License IDs on the SPDX License List. @@ -66,15 +63,15 @@ Deprecated license identifiers will be listed at the bottom of the SPDX License There are three optional first-level metadata fields that can be nested immediately under `` or ``, each of which is optional: -- **``**: Defines cross-references to URLs where the license can be found in use by one or a few projects, and (if applicable) where posted by the license steward -- **``**: Describes general comments about the license; if deprecated, also briefly explain the reason for deprecating the license identifier -- **``** (if license is deprecated): Lists the license(s) that should be used instead of this deprecated license +* **``**: Defines cross-references to URLs where the license can be found in use by one or a few projects, and (if applicable) where posted by the license steward +* **``**: Describes general comments about the license; if deprecated, also briefly explain the reason for deprecating the license identifier +* **``** (if license is deprecated): Lists the license(s) that should be used instead of this deprecated license ### License text Then, the actual license text would be contained within the `` section: -- **``**: Defines the actual text and templating for the license +* **``**: Defines the actual text and templating for the license Example: @@ -97,12 +94,12 @@ Example: Some portions of the license text can be surrounded by annotation tags, to denote certain sections of the license text: -- **``**: indicates the title of the license, if specified in the license text itself -- **``**: indicates where a copyright notice would be placed for the licensed code - - Note that `` should _not_ be used for copyright notices that apply to the copyright in the license text itself! -- **``**: indicates a standard way that the license recommends specifying the license, e.g. in code comments - - Note that `` should _only_ be used if it is defined by the license text itself! - - Typically, this would be located in an appendix titled something like "How to apply the license to your work" +* **``**: indicates the title of the license, if specified in the license text itself +* **``**: indicates where a copyright notice would be placed for the licensed code + * Note that `` should _not_ be used for copyright notices that apply to the copyright in the license text itself! +* **``**: indicates a standard way that the license recommends specifying the license, e.g. in code comments + * Note that `` should _only_ be used if it is defined by the license text itself! + * Typically, this would be located in an appendix titled something like "How to apply the license to your work" ### Paragraphs and newlines @@ -118,11 +115,11 @@ Numbered lists (e.g., a series of numbered sections) and unnumbered lists (e.g., Here are the basic rules: -- The list as a whole should be surrounded with **`...`** tags. -- Within the ``, each item in the list should be surrounded with **`...`** tags. -- If a list item has a section number or a bullet point at the start, the section number or bullet should be surrounded with **`...`** tags. -- Sub-lists can be nested within an item, to indicate e.g. subsections within an overarching numbered section. -- Items can also contain **`

...

`** tags, as needed if an item contains multiple paragraphs. +* The list as a whole should be surrounded with **`...`** tags. +* Within the ``, each item in the list should be surrounded with **`...`** tags. +* If a list item has a section number or a bullet point at the start, the section number or bullet should be surrounded with **`...`** tags. +* Sub-lists can be nested within an item, to indicate e.g. subsections within an overarching numbered section. +* Items can also contain **`

...

`** tags, as needed if an item contains multiple paragraphs. Example: @@ -167,17 +164,15 @@ Note that some annotated portions of text (specifically `` and `...`** tag. The **** tag includes two attributes: - -- `name`: specifies a unique name for this matching element -- `match`: specifies a [POSIX extended regular expression (ERE)](http://pubs.opengroup.org/onlinepubs/9699919799/) for what text will match +* `name`: specifies a unique name for this matching element +* `match`: specifies a [POSIX extended regular expression (ERE)](http://pubs.opengroup.org/onlinepubs/9699919799/) for what text will match Note that an example of actually-matching text should be included between the `` and `` tags, as the specified example is what will be rendered on the SPDX License List website page and in license text files provided by SPDX. To the extent a license has a "canonical" or "most commonly used" standard language, use that in the match between the `alt` tags. Learning regular expressions is outside the scope of this document. However, here are a few of the most common patterns, taken from [BSD-3-Clause](../src/BSD-3-Clause.xml) which is a good example of using several `` tags effectively: - -- `are`: Matches if the text is either the word "are" or the word "is" -- `EXPRESS`: Matches if the text is either the word "EXPRESS" or the word "EXPRESSED" -- `THE COPYRIGHT HOLDERS AND CONTRIBUTORS`: Matches anything as long as it consists of at least one or more characters +* `are`: Matches if the text is either the word "are" or the word "is" +* `EXPRESS`: Matches if the text is either the word "EXPRESS" or the word "EXPRESSED" +* `THE COPYRIGHT HOLDERS AND CONTRIBUTORS`: Matches anything as long as it consists of at least one or more characters ### Other things to watch out for