diff mbox series

[scarthgap] ref-manual/classes.rst: document the vex class

Message ID 20260825144520.16267-1-aleksandar.nikolic22@pm.me
State New
Headers show
Series [scarthgap] ref-manual/classes.rst: document the vex class | expand

Commit Message

Aleksandar Nikolic Aug. 25, 2026, 2:45 p.m. UTC 
From: Aleksandar Nikolic <aleksandar.nikolic@zeiss.com>

This class has been in OE-Core on Scarthgap for a while but never
documented in the reference manual. Copy the description from master.

Signed-off-by: Aleksandar Nikolic <aleksandar.nikolic@zeiss.com>
---
 documentation/ref-manual/classes.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

Comments

Antonin Godard Aug. 25, 2026, 2:53 p.m. UTC | #1 
Hi,

On Tue Aug 25, 2026 at 4:45 PM CEST, Aleksandar Nikolic via lists.yoctoproject.org wrote:
> From: Aleksandar Nikolic <aleksandar.nikolic@zeiss.com>
>
> This class has been in OE-Core on Scarthgap for a while but never
> documented in the reference manual. Copy the description from master.

Usually in these situations you would cherry-pick the patch from master with
`git cherry-pick -x --signoff <commit>`, and send the patch to the list.

I've cherry-picked commit 32cf3414f5ed ("ref-manual: add new vex class") and
applied it to scarthgap-next, thanks for the heads-up!

Antonin
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 79ed905d5..887cc0c15 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -3642,6 +3642,27 @@  using the Vala programming language.
 
 .. _ref-classes-waf:
 
+.. _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.
+
+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.
+
+Example usage::
+
+   bitbake -c generate_vex openssl
+
 ``waf``
 =======