From 6fb4c79030e9eb6ac18660e30cfce8227a0d204b Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Fri, 27 Oct 2023 19:45:43 +0200 Subject: 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 Signed-off-by: Richard Purdie --- documentation/dev-manual/vulnerabilities.rst | 3 +++ documentation/ref-manual/variables.rst | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) (limited to 'documentation') 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 -- cgit v1.2.3-54-g00ecf