From: Michael Opdenacker <michael.opdenacker@bootlin.com>
To: belouargamohamed@gmail.com
Cc: YP docs mailing list <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH 2/2] documentation: add documentation of the variable SPDX_NAMESPACE_PREFIX
Date: Fri, 23 Feb 2024 11:18:08 +0100 [thread overview]
Message-ID: <795e8e0a-34ea-4a94-bd50-6fc6a4b32054@bootlin.com> (raw)
In-Reply-To: <79156a5c-b233-4940-88f1-a5d04e4f9920@bootlin.com>
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.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
prev parent reply other threads:[~2024-02-23 10:18 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-14 21:52 [PATCH 2/2] documentation: add documentation of the variable SPDX_NAMESPACE_PREFIX belouargamohamed
2024-02-15 9:55 ` [docs] " Michael Opdenacker
2024-02-23 10:18 ` Michael Opdenacker [this message]
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=795e8e0a-34ea-4a94-bd50-6fc6a4b32054@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=belouargamohamed@gmail.com \
--cc=docs@lists.yoctoproject.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).