Re: [docs] [PATCH 01/16] ref-manual: add missing CVE_CHECK manifest variables

[Michael Opdenacker <michael.opdenacker@rootcommit.com>]

Hi Antonin

On 10/9/24 09:40, Antonin Godard via lists.yoctoproject.org wrote:
> From: Antonin Godard <antonin.godard@bootlin.com>
>
> Variables that can be used for toggling creation of manifest and
> specifying the path to the output in the deploy directory.
>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 12 ++++++++++++
>   1 file changed, 12 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 32c9e7407..0236c8c9c 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -1678,9 +1678,21 @@ system and gives an overview of their function and contents.
>            variable only in certain contexts (e.g. when building for kernel
>            and kernel module recipes).
>   
> +   :term:`CVE_CHECK_CREATE_MANIFEST`
> +      Specifies whether to create a CVE manifest to place in the deploy
> +      directory. The default is "1".
> +
>      :term:`CVE_CHECK_IGNORE`
>         This variable is deprecated and should be replaced by :term:`CVE_STATUS`.
>   
> +   :term:`CVE_CHECK_MANIFEST_JSON`
> +      Specifies the path to the CVE manifest in json format. See
> +      :term:`CVE_CHECK_CREATE_MANIFEST`.
> +
> +   :term:`CVE_CHECK_MANIFEST_JSON_SUFFIX`
> +      Allows to modify the json manifest suffix. See
> +      :term:`CVE_CHECK_MANIFEST_JSON`.
> +


I would use "JSON" instead of "json" in the above changes. IMHO that's a 
more explicit way to describe a format, and except for a few cases, 
"JSON" is more frequently used in the current docs.
Cheers
Michael.

-- 
Michael Opdenacker
Root Commit
https://rootcommit.com