Re: [docs] [PATCH] ref-manual: add more explanation to glossary variable LICENSE

Quentin Schulz <[email protected]>
Newsgroups org.yoctoproject.lists.docs
Message-ID <[email protected]>
Hi Robert,

On 6/17/26 1:56 PM, Robert P. J. Day via lists.yoctoproject.org wrote:
> 
> Add the following to the variable glossary LICENSE entry:
> 
>    - it is a required variable in an OE recipe
>    - it must be accompanied by LIC_FILES_CHKSUM, except in the
>      case where LICENSE = "CLOSED"
> 
> Signed-off-by: Robert P. J. Day <[email protected]>
> 
> ---
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index df3666f1c..3558ccf2d 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -5871,7 +5871,8 @@ system and gives an overview of their function and contents.
>         section in the Yocto Project Development Tasks Manual.
> 
>      :term:`LICENSE`
> -      The list of source licenses for the recipe. Follow these rules:
> +      This is a required field in an Openembedded recipe file, and should

Isn't it required for all recipes? It's a bit confusing to say 
"Openembedded recipe file" when I believe it applies to all recipes 
(provided you use OE-Core, but if you're reading the YP docs, you must 
have it included, if it were the BitBake docs it'd be different).

> +      contain a list of source licenses for the recipe. Follow these rules:
> 
>         -  Do not use spaces within individual license names.
> 
> @@ -5911,6 +5912,12 @@ system and gives an overview of their function and contents.
>            LICENSE:${PN} = "GPL-2.0.only"
>            LICENSE:${PN}-doc = "GFDL-1.2"
> 
> +      .. note::
> +
> +         A recipe's :term:`LICENSE` value must be accompanied by an associated
> +         :term:`LIC_FILES_CHKSUM` value, except in the special case where
> +         the :term:`LICENSE` value is set to "CLOSED".

Remove mention of "value", it's unnecessarily verbose.

Cheers,
Quentin
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.