summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/classes.rst25
1 files changed, 25 insertions, 0 deletions
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
3489The :ref:`ref-classes-vala` class supports recipes that need to build software written 3489The :ref:`ref-classes-vala` class supports recipes that need to build software written
3490using the Vala programming language. 3490using the Vala programming language.
3491 3491
3492.. _ref-classes-vex:
3493
3494``vex``
3495========
3496
3497The :ref:`ref-classes-vex` class is used to generate metadata needed by external
3498tools to check for vulnerabilities, for example CVEs. It can be used as a
3499replacement for :ref:`ref-classes-cve-check`.
3500
3501In order to use this class, inherit the class in the ``local.conf`` file and it
3502will add the ``generate_vex`` task for every recipe::
3503
3504 INHERIT += "vex"
3505
3506If an image is built it will generate a report in :term:`DEPLOY_DIR_IMAGE` for
3507all the packages used, it will also generate a file for all recipes used in the
3508build.
3509
3510Variables use the ``CVE_CHECK`` prefix to keep compatibility with the
3511:ref:`ref-classes-cve-check` class.
3512
3513Example usage::
3514
3515 bitbake -c generate_vex openssl
3516
3492.. _ref-classes-waf: 3517.. _ref-classes-waf:
3493 3518
3494``waf`` 3519``waf``