diff mbox series

manuals: improve description of CVE_STATUS and CVE_STATUS_GROUPS

Message ID 20231027174803.1641658-1-michael.opdenacker@bootlin.com
State New
Headers show
Series manuals: improve description of CVE_STATUS and CVE_STATUS_GROUPS | expand

Commit Message

Michael Opdenacker Oct. 27, 2023, 5:48 p.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

- 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.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/vulnerabilities.rst | 3 +++
 documentation/ref-manual/variables.rst       | 3 ++-
 2 files changed, 5 insertions(+), 1 deletion(-)
diff mbox series

Patch

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
 As mentioned previously, if data in the CVE database is wrong, it is recommend to fix those
 issues in the CVE database directly.
 
+Note that if there are many CVEs with the same status and reason, those can be
+shared by using the :term:`CVE_STATUS_GROUPS` variable.
+
 Recipes can be completely skipped by CVE check by including the recipe name in
 the :term:`CVE_CHECK_SKIP_RECIPE` variable.
 
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.
 
       It has the format "reason: description" and the description is optional.
       The Reason is mapped to the final CVE state by mapping via
-      :term:`CVE_CHECK_STATUSMAP`
+      :term:`CVE_CHECK_STATUSMAP`. See :ref:`dev-manual/vulnerabilities:fixing vulnerabilities in recipes`
+      for details.
 
    :term:`CVE_STATUS_GROUPS`
       If there are many CVEs with the same status and reason, they can by simplified by using this