From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: JPEWhacker@gmail.com, mikko.rapeli@linaro.org,
Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH v2 0/5] manuals: add documentation about SBOM/SPDX generation
Date: Fri, 28 Oct 2022 17:10:28 +0200 [thread overview]
Message-ID: <20221028151033.383087-1-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <17224368BE5A21CF.6604@lists.yoctoproject.org>
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
manual
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(-)
--
2.34.1
next parent reply other threads:[~2022-10-28 15:10 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <17224368BE5A21CF.6604@lists.yoctoproject.org>
2022-10-28 15:10 ` michael.opdenacker [this message]
2022-10-28 15:10 ` [PATCH v2 1/5] ref-manual: terms.rst: add SBOM and SPDX terms michael.opdenacker
2022-10-28 15:10 ` [PATCH v2 2/5] ref-manual: variables.rst: document spdx-create class variables michael.opdenacker
2022-10-28 15:10 ` [PATCH v2 3/5] dev-manual: common-tasks.rst: add section about SPDX / SBOM generation michael.opdenacker
2022-10-28 15:10 ` [PATCH v2 4/5] ref-manual: classes.rst: expand documentation of create-spdx class michael.opdenacker
2022-10-28 15:10 ` [PATCH v2 5/5] ref-manual: terms.rst: add reference to new SBOM/SPDX section in dev manual michael.opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221028151033.383087-1-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=JPEWhacker@gmail.com \
--cc=docs@lists.yoctoproject.org \
--cc=mikko.rapeli@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox