Skip to content

Commit 3503e5d

Browse files
tobiwan88kartben
authored andcommitted
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 <[email protected]>
1 parent 8c0e42f commit 3503e5d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/develop/west/zephyr-cmds.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,18 @@ To use this command:
105105
106106
west spdx -d BUILD_DIR
107107
108+
.. note::
109+
110+
When building with :ref:`sysbuild`, make sure you target the actual application
111+
which you want to generate the SBOM for. For example, if the application is
112+
named ``hello_world``:
113+
114+
.. code-block:: bash
115+
116+
west spdx --init -d BUILD_DIR/hello_world
117+
west build -d BUILD_DIR/hello_world
118+
west spdx -d BUILD_DIR/hello_world
119+
108120
This generates the following SPDX bill-of-materials (BOM) documents in
109121
:file:`BUILD_DIR/spdx/`:
110122

0 commit comments

Comments
 (0)