mbox series

[v2,0/5] manuals: add documentation about SBOM/SPDX generation

Message ID 20221028151033.383087-1-michael.opdenacker@bootlin.com
Headers show
Series manuals: add documentation about SBOM/SPDX generation | expand


Michael Opdenacker Oct. 28, 2022, 3:10 p.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Even though the create-spdx class has been available
for several versions, it wasn't documented at all
until very recently.

This is a first version, which could be expanded
thanks to your feedback or later.

In particular, I'd be interested in references
to outside SPDX tools to consume (in particular
browsing or analysing) the SPDX we generate.

I wouldn't be surprised if there are inaccuracies,
so thank you in advance for your reviews!

Changes in V2:
- Rebase against the newest master-next
- In description of the "spdx-create" class,
  put the output in tmp/deploy/images first.
  (Reported by Joshua Watt)
- Improve wording with respect to license
  compliance as suggested by Mikko Rapeli.

Michael Opdenacker (5):
  ref-manual: terms.rst: add SBOM and SPDX terms
  ref-manual: variables.rst: document spdx-create class variables
  dev-manual: common-tasks.rst: add section about SPDX / SBOM generation
  ref-manual: classes.rst: expand documentation of create-spdx class
  ref-manual: terms.rst: add reference to new SBOM/SPDX section in dev

 documentation/dev-manual/common-tasks.rst | 101 ++++++++++++++--------
 documentation/ref-manual/classes.rst      |  22 ++++-
 documentation/ref-manual/terms.rst        |  28 ++++++
 documentation/ref-manual/variables.rst    |  82 ++++++++++++++++++
 4 files changed, 196 insertions(+), 37 deletions(-)