Re: [docs] [PATCH] ref-manual: explain default value used for SUMMARY metadata

Hi,

On Wed Jun 17, 2026 at 1:34 PM CEST, Robert P. J. Day wrote:
>
> Explain that if you don't set a value for the SUMMARY variable in a
> recipe, it will get this default value from bitbake.conf:
>
>   SUMMARY ?= "${PN} version ${PV}-${PR}"
>
> 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..bb142dc4b 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -10350,6 +10350,11 @@ system and gives an overview of their function and contents.
>        :term:`DESCRIPTION` variable if :term:`DESCRIPTION` is
>        not set in the recipe.
>
> +      If you don't set this variable in your recipe file, it will contain
> +      the default value as set in the ``bitbake.conf`` file::
> +
> +         SUMMARY ?= "${PN} version ${PV}-${PR}"

I would avoid providing the value here, as it costs maintenance. You can
simplify this sentence like so:

"""
If you don't set this variable in your recipe file, it will contain a default
value as set in the :oecore_path:`meta/conf/bitbake.conf` file.
"""

Antonin