diff mbox series

ref-manual/variables.rst: link *MIRRORS definitions to the BitBake manual

Message ID 20260601-link-mirrors-def-bitbake-v1-1-fa69ec343eac@bootlin.com
State New
Headers show
Series ref-manual/variables.rst: link *MIRRORS definitions to the BitBake manual | expand

Commit Message

Antonin Godard June 1, 2026, 1:29 p.m. UTC
Those are defined in BitBake documented, and would be better documented
there. Add a link to the BitBake manual for these variables.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 6 ++++++
 1 file changed, 6 insertions(+)


---
base-commit: d7376cca64a0784e59d4fd60b9baefb4da2ce289
change-id: 20260601-link-mirrors-def-bitbake-7d3ab63bda92

Comments

Quentin Schulz June 1, 2026, 1:33 p.m. UTC | #1
Hi Antonin,

On 6/1/26 3:29 PM, Antonin Godard via lists.yoctoproject.org wrote:
> Those are defined in BitBake documented, and would be better documented
> there. Add a link to the BitBake manual for these variables.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index c65794229..fe3d5a999 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -6303,6 +6303,9 @@ system and gives an overview of their function and contents.
>         The default value for :term:`MIRRORS` is defined in the
>         ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer.
>   
> +      See the definition of this variable in the BitBake Manual for more
> +      details: :term:`bitbake:MIRRORS`.
> +

Should we remove the first paragraph and point to the BitBake reference 
manual directly?

>      :term:`MLPREFIX`
>         Specifies a prefix has been added to :term:`PN` to create a
>         special version of a recipe or package (i.e. a Multilib version). The
> @@ -7757,6 +7760,9 @@ system and gives an overview of their function and contents.
>         ``file://`` URLs to point to local directories or network shares as
>         well.
>   
> +      See the definition of this variable in the BitBake Manual for more
> +      details: :term:`bitbake:PREMIRRORS`.
> +

Should we slim down this entry and simply point at the BitBake reference 
manual directly?

Change itself is fine, so

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c65794229..fe3d5a999 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6303,6 +6303,9 @@  system and gives an overview of their function and contents.
       The default value for :term:`MIRRORS` is defined in the
       ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer.
 
+      See the definition of this variable in the BitBake Manual for more
+      details: :term:`bitbake:MIRRORS`.
+
    :term:`MLPREFIX`
       Specifies a prefix has been added to :term:`PN` to create a
       special version of a recipe or package (i.e. a Multilib version). The
@@ -7757,6 +7760,9 @@  system and gives an overview of their function and contents.
       ``file://`` URLs to point to local directories or network shares as
       well.
 
+      See the definition of this variable in the BitBake Manual for more
+      details: :term:`bitbake:PREMIRRORS`.
+
    :term:`PRIORITY`
       Indicates the importance of a package.