| Message ID | 20240214215237.151434-1-m.belouarga@technologyandstrategy.com |
|---|---|
| State | New |
| Headers | show |
| Series | None | expand |
Hi Mohamed, On 2/14/24 at 22:52, 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. > > [ YOCTO #15398 ] > > 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 6f7d6ff01e..907575ba82 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -7913,6 +7913,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: > + ``https://spdx.org/spdxdocs`` . > + This looks good to me, thanks! However, I have to wait for your first patch to be merged to merge this one, otherwise the default value is incorrect. Don't hesitate to ping me if necessary. As a separate patch, you may also mention this variable in the description of the "create-spdx" class (ref-manual/classes.rst). Otherwise, people may overlook this variable, if it's not referred to from any other place. Thanks again Michael.
Hi Mohamed, On 2/15/24 at 10:55, Michael Opdenacker wrote: > Hi Mohamed, > > On 2/14/24 at 22:52, 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. >> >> [ YOCTO #15398 ] >> >> 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 6f7d6ff01e..907575ba82 100644 >> --- a/documentation/ref-manual/variables.rst >> +++ b/documentation/ref-manual/variables.rst >> @@ -7913,6 +7913,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: >> + ``https://spdx.org/spdxdocs`` . >> + > > > This looks good to me, thanks! > However, I have to wait for your first patch to be merged to merge > this one, otherwise the default value is incorrect. > Don't hesitate to ping me if necessary. > > As a separate patch, you may also mention this variable in the > description of the "create-spdx" class (ref-manual/classes.rst). > Otherwise, people may overlook this variable, if it's not referred to > from any other place. Any news about the first patch? Don't hesitate to get back to me when it is merged. Another possibility, if the first patch doesn't make it, is to add the change without mentioning the default value. I'll be glad to do it in case you don't have time at the moment. Cheers Michael.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 6f7d6ff01e..907575ba82 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7913,6 +7913,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: + ``https://spdx.org/spdxdocs`` . + :term:`SPDX_PRETTY` This option makes the SPDX output more human-readable, using identation and newlines, instead of the default output in a