Re: [docs] [PATCH v2] ref-manual: add missing entry for build/tmp/deploy/spdx

"Robert P. J. Day" <[email protected]> Thu, 25 Jun 2026 04:23:41 -0400 (EDT)
Newsgroups org.yoctoproject.lists.docs
Message-ID <[email protected]>
On Thu, 25 Jun 2026, Antonin Godard via lists.yoctoproject.org wrote:

> Hi,
>
> On Wed Jun 24, 2026 at 2:40 PM CEST, Robert P. J. Day wrote:
> >
> > There is no entry in the Build Directory section for the directory
> > build/tmp/deploy/spdx, so add it.
> >
> > Signed-off-by: Robert P. J. Day <[email protected]>
> >
> > ---
> >
> >   i'm going with SBOM referring to the entirety of all that SPDX info.
> >
> > diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
> > index ff84b250b..0e8674d68 100644
> > --- a/documentation/ref-manual/structure.rst
> > +++ b/documentation/ref-manual/structure.rst
> > @@ -539,6 +539,16 @@ licensing, see the
> >  ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`"
> >  section in the Yocto Project Development Tasks Manual.
> >
> > +.. _structure-build-tmp-deploy-spdx:
> > +
> > +``build/tmp/deploy/spdx/``
> > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > +
> > +This directory contains a Software Bill of Materials (:term:`SBOM`) in
> > +:term:`SPDX` format, as explained in detail in the
> > +":ref:`dev-manual/sbom:creating a software bill of materials`"
> > +section of the Yocto Project Development Tasks Manual.
>
> How about:
>
> """
> This directory contains JSON files in :term:`SPDX` format which are used to
> create a Software Bill of Materials (:term:`SBOM`), as explained in detail in
> the ":ref:`dev-manual/sbom:creating a software bill of materials`" section of
> the Yocto Project Development Tasks Manual.
> """
>
> The sentence as it is sounds off to me.

  i'm good with that, but it sounds like we don't have a clear and
unambiguous definition of "Software Bill of Materials" yet.

  patch coming.

rday