Skip to content

Commit f502d5b

Browse files
authored
Merge pull request #1285 from bact/iso-shall-license-matching
Use ISO shall: license-matching-guidelines-and-templates
2 parents ff39d45 + 6393dec commit f502d5b

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/annexes/license-matching-guidelines-and-templates.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ To ensure that when matching licenses and exceptions to the SPDX License List, t
3131

3232
### Guideline: verbatim text
3333

34-
License and exception text should be the same verbatim text (except for the guidelines stated here). The text should be in the same order, e.g., differently ordered paragraphs would not be considered a match.
34+
License and exception text shall be the same verbatim text (except for the guidelines stated here). The text shall be in the same order, e.g., differently ordered paragraphs shall not be considered a match.
3535

3636
### Guideline: no additional text
3737

38-
Matched text should only include that found in the vetted license or exception text. Where a license or exception found includes additional text or clauses, this should not be considered a match.
38+
Matched text shall only include that found in the vetted license or exception text. Where a license or exception found includes additional text or clauses, this shall not be considered a match.
3939

4040
### Guideline: replaceable text
4141

42-
Some licenses include text that refers to the specific copyright holder or author, yet the rest of the license is exactly the same. The intent here is to avoid the inclusion of a specific name in one part of the license resulting in a non-match where the license is otherwise an exact match to the legally substantive terms (e.g., the third clause and disclaimer in the BSD licenses, or the third, fourth, and fifth clauses of Apache-1.1). In these cases, there should be a positive license match.
42+
Some licenses include text that refers to the specific copyright holder or author, yet the rest of the license is exactly the same. The intent here is to avoid the inclusion of a specific name in one part of the license resulting in a non-match where the license is otherwise an exact match to the legally substantive terms (e.g., the third clause and disclaimer in the BSD licenses, or the third, fourth, and fifth clauses of Apache-1.1). In these cases, there shall be a positive license match.
4343

4444
The text indicated as such can be replaced with similar values (e.g., a different name or generic term; different date) and still be considered a positive match.
4545
This rule also applies to text-matching in official license headers,
@@ -59,9 +59,9 @@ The original replaceable text appears on the SPDX License List webpage in red te
5959

6060
### Guideline: omittable text
6161

62-
Some licenses have text that can simply be ignored. The intent here is to avoid the inclusion of certain text that is superfluous or irrelevant in regard to the substantive license text resulting in a non-match where the license is otherwise an exact match (e.g., directions on how to apply the license or other similar exhibits). In these cases, there should be a positive license match.
62+
Some licenses have text that can simply be ignored. The intent here is to avoid the inclusion of certain text that is superfluous or irrelevant in regard to the substantive license text resulting in a non-match where the license is otherwise an exact match (e.g., directions on how to apply the license or other similar exhibits). In these cases, there shall be a positive license match.
6363

64-
The license should be considered a match if the text indicated is present and matches OR the text indicated is missing altogether.
64+
The license shall be considered a match if the text indicated is present and matches, or the text indicated is missing altogether.
6565

6666
The following XML tag is used to implement this guideline: `<optional>`
6767

@@ -78,7 +78,7 @@ To avoid the possibility of a non-match due to different spacing of words, line
7878

7979
### Guideline
8080

81-
All whitespace should be treated as a single blank space.
81+
All whitespace shall be treated as a single blank space.
8282

8383
XML files do not require specific markup to implement this guideline.
8484

@@ -90,7 +90,7 @@ To avoid the possibility of a non-match due to lowercase or uppercase letters in
9090

9191
### Guideline
9292

93-
All uppercase and lowercase letters should be treated as lowercase letters.
93+
All uppercase and lowercase letters shall be treated as lowercase letters.
9494

9595
XML files do not require specific markup to implement this guideline.
9696

@@ -104,15 +104,15 @@ XML files do not require specific markup to implement this guideline, unless to
104104

105105
### Guideline: punctuation
106106

107-
Punctuation should be matched, unless otherwise stated in these guidelines or unless specific markup is added.
107+
Punctuation shall be matched, unless otherwise stated in these guidelines or unless specific markup is added.
108108

109109
### Guideline: hyphens, dashes
110110

111-
Any hyphen, dash, en dash, em dash, or other variation should be considered equivalent.
111+
Any hyphen, dash, en dash, em dash, or other variation shall be considered equivalent.
112112

113113
### Guideline: quotes
114114

115-
Any variation of quotations (single, double, curly, etc.) should be considered equivalent.
115+
Any variation of quotations (single, double, curly, etc.) shall be considered equivalent.
116116

117117
## Code comment indicators or separators
118118

@@ -125,13 +125,13 @@ e.g., `---`, `===`, `___`, or `***`.
125125

126126
### Guideline
127127

128-
Any kind of code comment indicator or prefix which occurs at the beginning of each line in a matchable section should be ignored for matching purposes.
128+
Any kind of code comment indicator or prefix which occurs at the beginning of each line in a matchable section shall be ignored for matching purposes.
129129

130130
XML files do not require specific markup to implement this guideline.
131131

132132
### Guideline
133133

134-
A non-letter character repeated 3 or more times to establish a visual separation should be ignored for matching purposes.
134+
A non-letter character repeated 3 or more times to establish a visual separation shall be ignored for matching purposes.
135135

136136
XML files do not require specific markup to implement this guideline.
137137

@@ -171,7 +171,7 @@ By having a rule regarding the use of "©", "(c)", or "copyright", we avoid the
171171

172172
### Guideline
173173

174-
"©", "(c)", or "Copyright" should be considered equivalent and interchangeable.
174+
"©", "(C)", "(c)", or "Copyright" shall be considered equivalent and interchangeable.
175175

176176
XML files do not require specific markup to implement this guideline.
177177
The copyright symbol is part of the copyright notice,
@@ -181,7 +181,7 @@ see implementation of that guideline in [Copyright notice](#copyright-notice).
181181

182182
### Purpose
183183

184-
To avoid a license mismatch merely because the copyright notice (usually found above the actual license or exception text) is different. The copyright notice is important information to be recorded elsewhere in the SPDX document, but for the purposes of matching a license to the SPDX License List, it should be ignored because it is not part of the substantive license text.
184+
To avoid a license mismatch merely because the copyright notice (usually found above the actual license or exception text) is different. The copyright notice is important information to be recorded elsewhere in the SPDX document, but for the purposes of matching a license to the SPDX License List, it shall be ignored because it is not part of the substantive license text.
185185

186186
### Guideline
187187

@@ -226,7 +226,7 @@ To avoid a license mismatch due to a difference in a hyperlink protocol (e.g. HT
226226

227227
### Guideline
228228

229-
`http://` and `https://` should be considered equivalent.
229+
`http://` and `https://` shall be considered equivalent.
230230

231231
XML files do not require specific markup to implement this guideline.
232232

@@ -260,7 +260,7 @@ A legacy template is composed of text with zero or more rules embedded in it.
260260
A rule is a variable section of a license wrapped between double angle brackets
261261
`<<>>` and is composed of 4 fields.
262262
Each field is separated with a semi-colon `;`.
263-
Rules cannot be embedded within other rules.
263+
Rules shall not be embedded within other rules.
264264
Rule fields begin with a case sensitive tag followed by an equal sign `=`.
265265

266266
Rule fields:

0 commit comments

Comments
 (0)