ref-manual: add new vex class

Add a brief description on the new vex.bbclass that is used to generate
metadata needed by external tools to check for vulnerabilities.

(From yocto-docs rev: 32cf3414f5ed127f59119e38639bc8dbd57b7891)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Antonin Godard
2024-10-09 09:41:00 +02:00
committed by Richard Purdie
parent b3a7565465
commit a91f06c3a6

View File

@@ -3489,6 +3489,31 @@ This class is enabled by default because it is inherited by the
The :ref:`ref-classes-vala` class supports recipes that need to build software written
using the Vala programming language.
.. _ref-classes-vex:
``vex``
========
The :ref:`ref-classes-vex` class is used to generate metadata needed by external
tools to check for vulnerabilities, for example CVEs. It can be used as a
replacement for :ref:`ref-classes-cve-check`.
In order to use this class, inherit the class in the ``local.conf`` file and it
will add the ``generate_vex`` task for every recipe::
INHERIT += "vex"
If an image is built it will generate a report in :term:`DEPLOY_DIR_IMAGE` for
all the packages used, it will also generate a file for all recipes used in the
build.
Variables use the ``CVE_CHECK`` prefix to keep compatibility with the
:ref:`ref-classes-cve-check` class.
Example usage::
bitbake -c generate_vex openssl
.. _ref-classes-waf:
``waf``