From a91f06c3a62eef378df8e48e2ee8f770adbf600f Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Wed, 9 Oct 2024 09:41:00 +0200 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'documentation') diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 9520d0bf7c..46d77d0e55 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -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`` -- cgit v1.2.3-54-g00ecf