diff mbox series

[4/5] doc: Add the term Variant

Message ID 20260126222743.411405-4-daiane.angolini@foundries.io
State New
Headers show
Series [1/5] doc: change some terminology around bitbake-setup | expand

Commit Message

Daiane Angolini Jan. 26, 2026, 10:27 p.m. UTC
It also add a description for the term based on the concept that a
variant is a fragment or a set of fragments.

Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io>
---
 .../bitbake-user-manual-environment-setup.rst          | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Antonin Godard Jan. 27, 2026, 10:28 a.m. UTC | #1
Hi,

On Mon Jan 26, 2026 at 11:27 PM CET, Daiane Angolini via lists.yoctoproject.org wrote:
> It also add a description for the term based on the concept that a
> variant is a fragment or a set of fragments.
>
> Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io>
> ---
>  .../bitbake-user-manual-environment-setup.rst          | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> index e316ead56..700e02216 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
> @@ -212,6 +212,16 @@ The following components are involved to create the content of these directories
>        It is also a Git repository, that contains a history of the setup instance
>        and updates made to it via :ref:`ref-bbsetup-command-update`.
>  
> +   :term:`Variant`
> +      A Variant is a fragment or a set of fragments grouped under a name that

I think multiple variants could contains different set of layers too
(bb-layers). So it's not limited to fragments?
Also bb-env-passthrough-additions, etc.

> +      makes sense for a project. It is a nested configuration within a
> +      :term:`BitBake Setup Template`.
> +
> +      A :term:`BitBake Setup Template` can contain multiple variants. Users
> +      select among them during the :ref:`ref-bbsetup-command-init` command to
> +      customize the :term:`Setup`. Variants enable scaling configurations by
> +      sharing common parameters in a parent while differing in specific settings.
> +
>     :term:`Registry`
>        A configuration registry is a place where one or more :term:`BitBake
>        Setup Templates <BitBake Setup Template>` are stored.


Antonin
Alexander Kanavin Jan. 27, 2026, 10:46 a.m. UTC | #2
On Tue, 27 Jan 2026 at 11:29, Antonin Godard via
lists.yoctoproject.org
<antonin.godard=bootlin.com@lists.yoctoproject.org> wrote:
> I think multiple variants could contains different set of layers too
> (bb-layers). So it's not limited to fragments?
> Also bb-env-passthrough-additions, etc.

TBH, I think we should drop 'variants' altogether, and just refer to
'bitbake configurations'. We can explain that a list of bitbake
configurations is formed by flattening the configurations template,
and when a user selects from that list, and further selects from
fragment choices, that selection (together with the layer spec)
becomes a *configuration instance*.

Alex
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
index e316ead56..700e02216 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -212,6 +212,16 @@  The following components are involved to create the content of these directories
       It is also a Git repository, that contains a history of the setup instance
       and updates made to it via :ref:`ref-bbsetup-command-update`.
 
+   :term:`Variant`
+      A Variant is a fragment or a set of fragments grouped under a name that
+      makes sense for a project. It is a nested configuration within a
+      :term:`BitBake Setup Template`.
+
+      A :term:`BitBake Setup Template` can contain multiple variants. Users
+      select among them during the :ref:`ref-bbsetup-command-init` command to
+      customize the :term:`Setup`. Variants enable scaling configurations by
+      sharing common parameters in a parent while differing in specific settings.
+
    :term:`Registry`
       A configuration registry is a place where one or more :term:`BitBake
       Setup Templates <BitBake Setup Template>` are stored.