From d0f32aa055a86a88aeafb0890d4cf4b7f24a1ffd Mon Sep 17 00:00:00 2001 From: Tobias Meyer Date: Wed, 16 Apr 2025 16:42:40 +0200 Subject: [PATCH] doc: sbom cmd more detail for build_dir when following the example it was not clear that BUILD_DIR needs to point to application for sysbuild builds Signed-off-by: Tobias Meyer --- doc/develop/west/zephyr-cmds.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/develop/west/zephyr-cmds.rst b/doc/develop/west/zephyr-cmds.rst index b4ef9532cff6..727fdd2fd71c 100644 --- a/doc/develop/west/zephyr-cmds.rst +++ b/doc/develop/west/zephyr-cmds.rst @@ -104,6 +104,18 @@ To use this command: west spdx -d BUILD_DIR +.. note:: + + When building with :ref:`sysbuild`, make sure you target the actual application + which you want to generate the SBOM for. For example, if the application is + named ``hello_world``: + + .. code-block:: bash + + west spdx --init -d BUILD_DIR/hello_world + west build -d BUILD_DIR/hello_world + west spdx -d BUILD_DIR/hello_world + This generates the following SPDX bill-of-materials (BOM) documents in :file:`BUILD_DIR/spdx/`: