[PATCH] ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX

[PATCH] ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX

[belouargamohamed]

From: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com>

The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist.
This variable is used to change the prefix of some links in SPDX docs.

Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com>
---
 documentation/ref-manual/variables.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6e66dc735..3f7c8e2c7 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7911,6 +7911,11 @@ system and gives an overview of their function and contents.
       image), compared to just using the :ref:`ref-classes-create-spdx` class
       with no option.
 
+   :term:`SPDX_NAMESPACE_PREFIX`
+      This option could be used in order to change the prefix of ``spdxDocument``
+      and the prefix of ``documentNamespace``. It is set by default to: 
+      ``http://spdx.org/spdxdoc`` .
+
    :term:`SPDX_PRETTY`
       This option makes the SPDX output more human-readable, using
       identation and newlines, instead of the default output in a
-- 
2.25.1

Re: [docs] [PATCH] ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX

[Michael Opdenacker]

Hi Mohamed

On 3/18/24 at 20:16, belouargamohamed@gmail.com wrote:
> From: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com>
>
> The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist.
> This variable is used to change the prefix of some links in SPDX docs.
>
> Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com>
> ---
>   documentation/ref-manual/variables.rst | 5 +++++
>   1 file changed, 5 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 6e66dc735..3f7c8e2c7 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7911,6 +7911,11 @@ system and gives an overview of their function and contents.
>         image), compared to just using the :ref:`ref-classes-create-spdx` class
>         with no option.
>   
> +   :term:`SPDX_NAMESPACE_PREFIX`
> +      This option could be used in order to change the prefix of ``spdxDocument``
> +      and the prefix of ``documentNamespace``. It is set by default to:
> +      ``http://spdx.org/spdxdoc`` .


Many thanks for adding this to the documentation!
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into master-next.
Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com