[4/5] ref-manual: classes.rst: expand documentation of create-spdx class

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/ref-manual/classes.rst | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

On Fri, Oct 28, 2022 at 5:19 AM Michael Opdenacker via
lists.yoctoproject.org
<michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
>
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  documentation/ref-manual/classes.rst | 20 ++++++++++++++++++--
>  1 file changed, 18 insertions(+), 2 deletions(-)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index cce0269b9a..621cf9c8b6 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -373,8 +373,24 @@ support.
>  ``create-spdx.bbclass``
>  =======================
>
> -The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for automatically creating
> -SPDX SBoM documents based upon image and SDK contents.
> +The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for
> +automatically creating :term:`SPDX` :term:`SBOM` documents based upon image
> +and SDK contents.
> +
> +This class is meant to be inherited globally from a configuration file::
> +
> +   INHERIT += "create-spdx"
> +
> +The output files are generated in ``tmp/deploy/spdx`` under the
> +:term:`Build Directory`.

Probably should mention the per-image output file here also

> +
> +The exact behaviour of this class, and the amount of output can be controlled
> +by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`,
> +:term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables.
> +
> +See the description of these variables and the
> +":ref:`dev-manual/common-tasks:creating a software bill of materials`"
> +section in the Yocto Project Development Manual for more details.
>
>  .. _ref-classes-cross:
>
> --
> 2.34.1
>
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#3435): https://lists.yoctoproject.org/g/docs/message/3435
> Mute This Topic: https://lists.yoctoproject.org/mt/94623294/3616693
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [JPEWhacker@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>

Hi Joshua

On 10/28/22 15:19, Joshua Watt wrote:
> On Fri, Oct 28, 2022 at 5:19 AM Michael Opdenacker via
> lists.yoctoproject.org
> <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> ---
>>   documentation/ref-manual/classes.rst | 20 ++++++++++++++++++--
>>   1 file changed, 18 insertions(+), 2 deletions(-)
>>
>> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
>> index cce0269b9a..621cf9c8b6 100644
>> --- a/documentation/ref-manual/classes.rst
>> +++ b/documentation/ref-manual/classes.rst
>> @@ -373,8 +373,24 @@ support.
>>   ``create-spdx.bbclass``
>>   =======================
>>
>> -The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for automatically creating
>> -SPDX SBoM documents based upon image and SDK contents.
>> +The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for
>> +automatically creating :term:`SPDX` :term:`SBOM` documents based upon image
>> +and SDK contents.
>> +
>> +This class is meant to be inherited globally from a configuration file::
>> +
>> +   INHERIT += "create-spdx"
>> +
>> +The output files are generated in ``tmp/deploy/spdx`` under the
>> +:term:`Build Directory`.
> Probably should mention the per-image output file here also


Ooops, of course. I forgot to change this part. Thanks!
Michael.