Skip to content

Commit b24415b

Browse files
committed
Clarify where the SBOM generator script lives
The Dynamically generated SBOMs section showed ``files('scripts/generate_sbom.py')`` without explaining that the script is project-authored (not provided by meson-python) and that its location is arbitrary. Add a short note pointing users at the PSF SBOMs for Python packages proposal for guidance on writing generators, and noting ``scripts/`` as a common convention.
1 parent bc3c11f commit b24415b

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

docs/how-to-guides/sboms.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,13 @@ writes the file and installs it to the same location:
6363
The generator runs during the build, and the output is routed into
6464
``my_project-1.0.0.dist-info/sboms/vendored.cdx.json``.
6565

66+
The generator is provided by the project; ``meson-python`` does not
67+
ship one. It can be a script checked into the source tree
68+
(``scripts/`` is a common convention) or a third-party generator
69+
installed via ``[build-system] requires``. For guidance on generator
70+
implementations and the SBOM format itself, see the PSF
71+
`SBOMs for Python packages`_ proposal.
72+
6673
Other ``.dist-info`` subdirectories
6774
===================================
6875

0 commit comments

Comments
 (0)