summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-10-27 19:45:43 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-10-30 11:11:17 +0000
commite0800e8d8a81111832d351d9a14a5ea9c2c09c50 (patch)
treeaac5ac86df0db5926b26b0f674344fc05cf61a85 /documentation
parentf9ddf08ffd964c61cb8f85ac3ca6b440071474dc (diff)
downloadpoky-e0800e8d8a81111832d351d9a14a5ea9c2c09c50.tar.gz
manuals: improve description of CVE_STATUS and CVE_STATUS_GROUPS
- Mention CVE_STATUS_GROUPS in the development manual (otherwise only present in the reference manual, but with no reference to it) - In the reference manual description of CVE_STATUS, link back to the development manual, to provide context. (From yocto-docs rev: cfef5fe41b6c819e783c88829448ae38141650a5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/vulnerabilities.rst3
-rw-r--r--documentation/ref-manual/variables.rst3
2 files changed, 5 insertions, 1 deletions
diff --git a/documentation/dev-manual/vulnerabilities.rst b/documentation/dev-manual/vulnerabilities.rst
index 71111bb3e2..c492b62ffd 100644
--- a/documentation/dev-manual/vulnerabilities.rst
+++ b/documentation/dev-manual/vulnerabilities.rst
@@ -164,6 +164,9 @@ the :term:`CVE_STATUS` variable flag with appropriate reason which is mapped to
164As mentioned previously, if data in the CVE database is wrong, it is recommend to fix those 164As mentioned previously, if data in the CVE database is wrong, it is recommend to fix those
165issues in the CVE database directly. 165issues in the CVE database directly.
166 166
167Note that if there are many CVEs with the same status and reason, those can be
168shared by using the :term:`CVE_STATUS_GROUPS` variable.
169
167Recipes can be completely skipped by CVE check by including the recipe name in 170Recipes can be completely skipped by CVE check by including the recipe name in
168the :term:`CVE_CHECK_SKIP_RECIPE` variable. 171the :term:`CVE_CHECK_SKIP_RECIPE` variable.
169 172
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index ef4d6a0534..2d875c984d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1724,7 +1724,8 @@ system and gives an overview of their function and contents.
1724 1724
1725 It has the format "reason: description" and the description is optional. 1725 It has the format "reason: description" and the description is optional.
1726 The Reason is mapped to the final CVE state by mapping via 1726 The Reason is mapped to the final CVE state by mapping via
1727 :term:`CVE_CHECK_STATUSMAP` 1727 :term:`CVE_CHECK_STATUSMAP`. See :ref:`dev-manual/vulnerabilities:fixing vulnerabilities in recipes`
1728 for details.
1728 1729
1729 :term:`CVE_STATUS_GROUPS` 1730 :term:`CVE_STATUS_GROUPS`
1730 If there are many CVEs with the same status and reason, they can by simplified by using this 1731 If there are many CVEs with the same status and reason, they can by simplified by using this