Skip to content

Commit 0488d02

Browse files
committed
Maintenance: Rendered delivery items for all three targets
Signed-off-by: Stefan Hagen <stefan@hagen.link>
1 parent afd9403 commit 0488d02

File tree

3 files changed

+45
-8
lines changed

3 files changed

+45
-8
lines changed

csaf_2.1/prose/share/csaf-v2.1-draft.html

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3736,6 +3736,9 @@ <h3 id="315-language-type-">
37363736
mandatory as most users are used to that.
37373737
</p>
37383738
</blockquote>
3739+
<p>
3740+
CSAF Producers SHALL follow the conventions for the capitalization of the subtags. CSAF Validators SHALL treat subtags as case-insensitive unless stated otherwise in the test.
3741+
</p>
37393742
<p>
37403743
<em>Examples 1:</em><a id='language-type-eg-1'></a><a id='sec-3-1-5-eg-1'></a><a id='example-23'></a>
37413744
</p>
@@ -8452,7 +8455,7 @@ <h3 id="6115-translator-">
84528455
6.1.15 Translator <a id='translator'></a>
84538456
</h3>
84548457
<p>
8455-
It MUST be tested that <code>/document/source_lang</code> is present if the value <code>translator</code> is used for <code>/document/publisher/category</code>.
8458+
It MUST be tested that <code>/document/source_lang</code> is present and set if the value <code>translator</code> is used for <code>/document/publisher/category</code>. A CSAF Validator SHALL differentiate in the error message between the key being present but having no or an empty value and not being present at all.
84568459
</p>
84578460
<p>
84588461
The relevant path for this test is:
@@ -8476,6 +8479,11 @@ <h3 id="6115-translator-">
84768479
The required element <code>source_lang</code> is missing.
84778480
</p>
84788481
</blockquote>
8482+
<blockquote>
8483+
<p>
8484+
A tool MAY add the key as a quick fix. In such case, the value still needs to be set - either manually or by other means from the tool, e.g. through a given configuration.
8485+
</p>
8486+
</blockquote>
84798487
<h3 id="6116-latest-document-version-">
84808488
6.1.16 Latest Document Version <a id='latest-document-version'></a>
84818489
</h3>
@@ -11539,7 +11547,7 @@ <h3 id="6212-missing-document-language-">
1153911547
6.2.12 Missing Document Language <a id='missing-document-language'></a>
1154011548
</h3>
1154111549
<p>
11542-
It MUST be tested that the document language member is present.
11550+
It MUST be tested that the document language member is present and set. A CSAF Validator SHALL differentiate in the error message between the key being present but having no or an empty value and not being present at all.
1154311551
</p>
1154411552
<p>
1154511553
The relevant path for this test is:
@@ -11566,6 +11574,11 @@ <h3 id="6212-missing-document-language-">
1156611574
The document language is not defined.
1156711575
</p>
1156811576
</blockquote>
11577+
<blockquote>
11578+
<p>
11579+
A tool MAY add the key as a quick fix. In such case, the value still needs to be set - either manually or by other means from the tool, e.g. through a given configuration.
11580+
</p>
11581+
</blockquote>
1156911582
<h3 id="6213-sorting-">
1157011583
6.2.13 Sorting <a id='recommended-tests--sorting'></a>
1157111584
</h3>
@@ -12930,7 +12943,7 @@ <h3 id="6243-missing-license-expression-">
1293012943
6.2.43 Missing License Expression <a id='missing-license-expression'></a>
1293112944
</h3>
1293212945
<p>
12933-
It MUST be tested that the license expression is present and set.
12946+
It MUST be tested that the license expression is present and set. A CSAF Validator SHALL differentiate in the error message between the key being present but having no or an empty value and not being present at all.
1293412947
</p>
1293512948
<p>
1293612949
The relevant path for this test is:
@@ -12952,6 +12965,11 @@ <h3 id="6243-missing-license-expression-">
1295212965
The license expression is not defined.
1295312966
</p>
1295412967
</blockquote>
12968+
<blockquote>
12969+
<p>
12970+
A tool MAY add the key as a quick fix. In such case, the value still needs to be set - either manually or by other means from the tool, e.g. through a given configuration.
12971+
</p>
12972+
</blockquote>
1295512973
<h3 id="6244-deprecated-license-identifier-">
1295612974
6.2.44 Deprecated License Identifier <a id='deprecated-license-identifier'></a>
1295712975
</h3>
@@ -17924,7 +17942,7 @@ <h3 id="9114-conformance-clause-14-csaf-basic-validator-">
1792417942
</li>
1792517943
<li>does not change the CSAF Documents.
1792617944
</li>
17927-
<li>satisfies those normative requirements in sections <a href="#extensions">2.4</a>, <a href="#mandatory-tests">6.1</a>, <a href="#test-presets">6.4</a>, and <a href="#safety-security-and-data-protection-considerations">8</a> that are designated as applying to CSAF Validators.
17945+
<li>satisfies those normative requirements in sections <a href="#extensions">2.4</a>, <a href="#schema-elements">3</a> <a href="#mandatory-tests">6.1</a>, <a href="#test-presets">6.4</a>, and <a href="#safety-security-and-data-protection-considerations">8</a> that are designated as applying to CSAF Validators.
1792817946
</li>
1792917947
<li>outputs a warning if an "not implemented warning" occurs as the validation status might not be correct.
1793017948
</li>

csaf_2.1/prose/share/csaf-v2.1-draft.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2152,6 +2152,9 @@ See IETF language registry: <https://www.iana.org/assignments/language-subtag-re
21522152
> Even though the private use language tags are supported they should not be used to ensure readability across the ecosystem.
21532153
> It is recommended to follow the conventions for the capitalization of the subtags even though it is not mandatory as most users are used to that.
21542154

2155+
CSAF Producers SHALL follow the conventions for the capitalization of the subtags.
2156+
CSAF Validators SHALL treat subtags as case-insensitive unless stated otherwise in the test.
2157+
21552158
*Examples 1:*<a id='language-type-eg-1'></a><a id='sec-3-1-5-eg-1'></a><a id='example-23'></a>
21562159

21572160
```
@@ -5844,7 +5847,9 @@ The relevant path for this test is:
58445847

58455848
### 6.1.15 Translator <a id='translator'></a>
58465849

5847-
It MUST be tested that `/document/source_lang` is present if the value `translator` is used for `/document/publisher/category`.
5850+
It MUST be tested that `/document/source_lang` is present and set if the value `translator` is used for `/document/publisher/category`.
5851+
A CSAF Validator SHALL differentiate in the error message between the key being present but having no or an empty value and
5852+
not being present at all.
58485853

58495854
The relevant path for this test is:
58505855

@@ -5869,6 +5874,9 @@ The relevant path for this test is:
58695874

58705875
> The required element `source_lang` is missing.
58715876

5877+
> A tool MAY add the key as a quick fix.
5878+
> In such case, the value still needs to be set - either manually or by other means from the tool, e.g. through a given configuration.
5879+
58725880
### 6.1.16 Latest Document Version <a id='latest-document-version'></a>
58735881

58745882
It MUST be tested that document version has the same value as the `number` in the last item of the revision history when
@@ -8820,7 +8828,9 @@ The relevant path for this test is:
88208828

88218829
### 6.2.12 Missing Document Language <a id='missing-document-language'></a>
88228830

8823-
It MUST be tested that the document language member is present.
8831+
It MUST be tested that the document language member is present and set.
8832+
A CSAF Validator SHALL differentiate in the error message between the key being present but having no or an empty value and
8833+
not being present at all.
88248834

88258835
The relevant path for this test is:
88268836

@@ -8848,6 +8858,9 @@ The relevant path for this test is:
88488858

88498859
> The document language is not defined.
88508860

8861+
> A tool MAY add the key as a quick fix.
8862+
> In such case, the value still needs to be set - either manually or by other means from the tool, e.g. through a given configuration.
8863+
88518864
### 6.2.13 Sorting <a id='recommended-tests--sorting'></a>
88528865

88538866
It MUST be tested that all keys in a CSAF document are sorted alphabetically.
@@ -10144,6 +10157,8 @@ The relevant paths for this test are:
1014410157
### 6.2.43 Missing License Expression <a id='missing-license-expression'></a>
1014510158

1014610159
It MUST be tested that the license expression is present and set.
10160+
A CSAF Validator SHALL differentiate in the error message between the key being present but having no or an empty value and
10161+
not being present at all.
1014710162

1014810163
The relevant path for this test is:
1014910164

@@ -10166,6 +10181,9 @@ The relevant path for this test is:
1016610181

1016710182
> The license expression is not defined.
1016810183

10184+
> A tool MAY add the key as a quick fix.
10185+
> In such case, the value still needs to be set - either manually or by other means from the tool, e.g. through a given configuration.
10186+
1016910187
### 6.2.44 Deprecated License Identifier <a id='deprecated-license-identifier'></a>
1017010188

1017110189
It MUST be tested that all license identifier and exceptions used are not deprecated.
@@ -14066,8 +14084,9 @@ A program satisfies the "CSAF Basic Validator" conformance profile if the progra
1406614084
including also the format validation (cf. section [2.2](#format-validation)).
1406714085
* performs all tests of the preset `mandatory` as given in section [6.4.1](#presets-defined-through-test-subsections).
1406814086
* does not change the CSAF Documents.
14069-
* satisfies those normative requirements in sections [2.4](#extensions), [6.1](#mandatory-tests), [6.4](#test-presets), and
14070-
[8](#safety-security-and-data-protection-considerations) that are designated as applying to CSAF Validators.
14087+
* satisfies those normative requirements in sections [2.4](#extensions), [3](#schema-elements) [6.1](#mandatory-tests),
14088+
[6.4](#test-presets), and [8](#safety-security-and-data-protection-considerations) that are designated as applying to
14089+
CSAF Validators.
1407114090
* outputs a warning if an "not implemented warning" occurs as the validation status might not be correct.
1407214091

1407314092
A CSAF Basic Validator MAY provide one or more additional functions:
1.27 KB
Binary file not shown.

0 commit comments

Comments
 (0)