diff mbox series

[16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS

Message ID e1277d4cbf71153fba9f56516864f23262c06ed1.1665392835.git.paul.eggleton@linux.microsoft.com
State New
Headers show
Series [01/34] migration-general: add section on using buildhistory | expand

Commit Message

Paul Eggleton Oct. 10, 2022, 9:24 a.m. UTC
From: Paul Eggleton <paul.eggleton@microsoft.com>

New variable in 4.1.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
 documentation/ref-manual/variables.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Peter Kjellerstedt Oct. 10, 2022, 1:55 p.m. UTC | #1
> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf
> Of Paul Eggleton
> Sent: den 10 oktober 2022 11:24
> To: docs@lists.yoctoproject.org
> Subject: [docs] [PATCH 16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS
> 
> From: Paul Eggleton <paul.eggleton@microsoft.com>
> 
> New variable in 4.1.
> 
> Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
> ---
>  documentation/ref-manual/variables.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 885641a..c226b92 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -1508,6 +1508,13 @@ system and gives an overview of their function and
> contents.
>           # This is windows only issue.
>           CVE_CHECK_IGNORE += "CVE-2020-15523"
> 
> +   :term:`CVE_CHECK_SHOW_WARNINGS`
> +      Specifies whether or not the :ref:`pypi <ref-classes-cve-check>` class

Change "pypi" to "cve-check".

> +      should generate warning messages on the console when unpatched CVEs
> +      are found. The default is "1", but you may wish to set it to "0" if you
> +      are already examining/processing the logs after the build has completed
> +      and thus do not need the warning messages.
> +
>     :term:`CVE_CHECK_SKIP_RECIPE`
>        The list of package names (:term:`PN`) for which
>        CVEs (Common Vulnerabilities and Exposures) are ignored.
> --
> 1.8.3.1

//Peter
Paul Eggleton Oct. 10, 2022, 7:34 p.m. UTC | #2
On Tuesday, 11 October 2022 02:55:17 NZDT Peter Kjellerstedt wrote:
> > --- a/documentation/ref-manual/variables.rst
> > +++ b/documentation/ref-manual/variables.rst
> > @@ -1508,6 +1508,13 @@ system and gives an overview of their function and
> > contents.
> > 
> >           # This is windows only issue.
> >           CVE_CHECK_IGNORE += "CVE-2020-15523"
> > 
> > +   :term:`CVE_CHECK_SHOW_WARNINGS`
> > +      Specifies whether or not the :ref:`pypi <ref-classes-cve-check>`
> > class
>
> Change "pypi" to "cve-check".

Oops - fixed on the branch.

Thanks
Paul
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 885641a..c226b92 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1508,6 +1508,13 @@  system and gives an overview of their function and contents.
          # This is windows only issue.
          CVE_CHECK_IGNORE += "CVE-2020-15523"
 
+   :term:`CVE_CHECK_SHOW_WARNINGS`
+      Specifies whether or not the :ref:`pypi <ref-classes-cve-check>` class
+      should generate warning messages on the console when unpatched CVEs
+      are found. The default is "1", but you may wish to set it to "0" if you
+      are already examining/processing the logs after the build has completed
+      and thus do not need the warning messages.
+
    :term:`CVE_CHECK_SKIP_RECIPE`
       The list of package names (:term:`PN`) for which
       CVEs (Common Vulnerabilities and Exposures) are ignored.