From patchwork Mon Jan 26 22:27:39 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daiane Angolini X-Patchwork-Id: 79713 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2B0ABD19520 for ; Mon, 26 Jan 2026 22:28:20 +0000 (UTC) Received: from mx0b-0031df01.pphosted.com (mx0b-0031df01.pphosted.com [205.220.180.131]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.33754.1769466489791008383 for ; Mon, 26 Jan 2026 14:28:10 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=XTg/Qusj; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: foundries.io, ip: 205.220.180.131, mailfrom: daiane.angolini@foundries.io) Received: from pps.filterd (m0279870.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QLW4lv4101101 for ; Mon, 26 Jan 2026 22:28:08 GMT Received: from mail-dy1-f197.google.com (mail-dy1-f197.google.com [74.125.82.197]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4bxg93g3vw-1 (version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT) for ; Mon, 26 Jan 2026 22:28:08 +0000 (GMT) Received: by mail-dy1-f197.google.com with SMTP id 5a478bee46e88-2b6f0b345e3so23873012eec.0 for ; Mon, 26 Jan 2026 14:28:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=foundries.io; s=google; t=1769466487; x=1770071287; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=mGMuoCKxg+v7CS/vJcrr+4TXPMAHV7TZ3bw9h2XlM2Y=; b=XTg/Qusj9wMtrymUTHMJzNnKIUpjOzsrvLwGJh9FMFeJkgHSIjAdu2YLBjzqXiRdUt CvublfTeEOygH5fso8IbQgiioLNumjpt+fNSQXIjFGkfh6xDZWSCXkWewXD0REVlDpbF U7OCh4BSctLpRA/kNLNIYJcKGgsVgKdcTCU5CqS9pMw5Eo7ZiBeVFsuZNdD4UpTj6u91 QKPyQbZLTcOBmlls9mgxpF4lmEqA9NHcj7L0Of7YfPIvMS1Hr7Jc04q3RKwPn7th3JqZ APdJ9PRbZY9EoKlsy9aXgM668RE5WXTDI+IAJn1T6hpRq7bWxS1nhGJymJKmPgsvb+e+ 5qRg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1769466487; x=1770071287; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=mGMuoCKxg+v7CS/vJcrr+4TXPMAHV7TZ3bw9h2XlM2Y=; b=pKJnrdoej2b5E0h3hz3iZqwBrxgdqCMD1V5dddlnotVN3Q8/gCKPECS/+YkA++KAzu cN8DjTas376bBfs+9yicXgFT8Paf9QzVxe6JjVhoyMB8GfSfin2hMtuxI1PXYRnCqe3D f+/6c0e1R0+L/3BL7CAHbwaBB3yiFukStHJk8F7ndRYmYsPDKKOu0sTDmJc7NZFm0kB8 GjSa4EgFpaeyfowjSzf4HgkJACgUzKI+/IXxqHxl6H1HSD5j9AFFaBrpv4VE2ljuBK1D W0f6Gxl9WD7kkecvDh4vS5uLOGl2t1gM+nEhNRYB5gq1UX3QIsCbY7htx1gauBDg9v3j lPvw== X-Gm-Message-State: AOJu0Yz+JFnrOgD18WrRcGndJkGi1Rawr/PAVVC8nccKlQSVBX58dxJS QMuvd4S4Zg4mQPKx5s5NlBfJxQ21wI8/wT7dl8282udKm25QwP2pciOyK1UamPRLcRpRrHQTjoq mYbKCJXF9n6Z5As6nAVvquPZhASHpjhagwdzKeGaKEROT7hyRd7HTxWKHDXyRkqVe56ZTR0QOhr xyYY5+VTDM X-Gm-Gg: AZuq6aIFqkWxIIdXxq7+fVm7dbbEN3/MmusLBZqS2yZHWMs9gDcGOuWES4YVENRuHyf 23L9xJwLWHXSbyTUJiRglo14aXxBuxXj7eWEMhWKNguE4qSRZYfbt6fl0okBRhqi5Z8kG1axks4 TqXfI6IiT552RcXxGycggu+4gt6f+X+5L53tGQvVSmrgdWfO69bwhU0JlmfLKwRwlGJ7mOjwMO9 4z3cmUMfxTq/i+E+nNo8m5shdKdezuHVDxKggy1HkQFN9oW+kivH0QlRNUU5MUfT1rqPvd475Zd ji1Lu3TZ6exmKDqsLfgQ0Ln5h7ycAp1RwnYX+68DjP0qo6/T/13TdwoaqyFgv7D5PDIKs81+Br8 3PiKuFmzUSk8lcycCHJsZPhY85VLQ2dZIg6PoeaxpsORRlBOqT6Kz7lPDjhSH6fz5OimpWVdtGp qeYg== X-Received: by 2002:a05:7300:80ce:b0:2b7:18eb:a0ba with SMTP id 5a478bee46e88-2b76451543amr3239758eec.36.1769466486899; Mon, 26 Jan 2026 14:28:06 -0800 (PST) X-Received: by 2002:a05:7300:80ce:b0:2b7:18eb:a0ba with SMTP id 5a478bee46e88-2b76451543amr3239736eec.36.1769466486149; Mon, 26 Jan 2026 14:28:06 -0800 (PST) Received: from lola.lan ([187.183.40.109]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2b73a6b6227sm15057543eec.8.2026.01.26.14.28.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jan 2026 14:28:05 -0800 (PST) From: Daiane Angolini To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Daiane Angolini Subject: [docs][PATCH 1/5] doc: change some terminology around bitbake-setup Date: Mon, 26 Jan 2026 19:27:39 -0300 Message-Id: <20260126222743.411405-1-daiane.angolini@foundries.io> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX4w6ancoR8vw3 DbMoYNv4n9sEHEL5b/pYjK1SRrA+irLm7N6g50Ovx1O8nqsKCvW3VM0uKj9CmUrZtn6sW3W/ioS kbCLvW7GLNLR1KcSF4Hw8z/y/1xcJIptJnO5ebKW3iLtZE+8JwMunrQSSHzcF6ziZeVVex+LPVW B21U/sVWkGyA3puqissm5CL9pV0JJ33CgzIHbdq2OKBx8yJV07WQZLJb3aAoHUdtmKLrkhcHL4T Mzoy5jtEhND5djnW5QudZ9bIUPF2lNMlDjkD8xhQoODdrGnH4809kIzZ1tylQzEC6vIctANF6VQ SY9BytfoWa/7wY+N0AALUM2oq7xVMJgIn/6OPd9F8rTva8wbrr1r5nGTjwXxvNqRjJfbsZMMVQj Tb4DrzfJzQrgXbauJf157wLnSwdbeNf0pvuX8RdmwVj6oA6lFKeWIMDf31g4/rhoNI7sWhIm+Eg s0sJJ9N//lXQ0DUnhvg== X-Authority-Analysis: v=2.4 cv=Uc1ciaSN c=1 sm=1 tr=0 ts=6977ea78 cx=c_pps a=Uww141gWH0fZj/3QKPojxA==:117 a=PIITv4rVe324bgT4salBLw==:17 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=A1X0JdhQAAAA:8 a=Y_ynoO3N8lTnrvQkgkkA:9 a=PxkB5W3o20Ba91AHUih5:22 X-Proofpoint-ORIG-GUID: GQGFTI5-ySFGKUf2wX2Ng9I0alJGUm3t X-Proofpoint-GUID: GQGFTI5-ySFGKUf2wX2Ng9I0alJGUm3t X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1121,Hydra:6.1.20,FMLib:17.12.100.49 definitions=2026-01-26_04,2026-01-26_01,2025-10-01_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 suspectscore=0 lowpriorityscore=0 clxscore=1015 priorityscore=1501 impostorscore=0 malwarescore=0 phishscore=0 spamscore=0 bulkscore=0 adultscore=0 classifier=typeunknown authscore=0 authtc= authcc= route=outbound adjust=0 reason=mlx scancount=1 engine=8.22.0-2601150000 definitions=main-2601260192 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 26 Jan 2026 22:28:20 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/bitbake-devel/message/18871 Change some terms to use more specific wording: Generic Configuration -> BitBake Setup Template Specific Configuration -> BitBake Setup Instance nested configurations -> Variant Signed-off-by: Daiane Angolini --- .../bitbake-user-manual-environment-setup.rst | 88 +++++++++---------- 1 file changed, 44 insertions(+), 44 deletions(-) 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 3b6a73fd8..824b01ffb 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst @@ -41,8 +41,8 @@ Quick Start $ ./bitbake/bin/bitbake-setup init This command will ask you to choose which configurations to use available as - part of the default BitBake :term:`generic configurations `. + part of the default BitBake :term:`BitBake Setup Templates `. .. note:: @@ -73,8 +73,8 @@ Quick Start The name of the directory will vary depending on the choices. - - ``config/``: holds the :term:`Specific Configuration`, which embeds the - :term:`Generic Configuration` (first choice of the :ref:`ref-bbsetup-command-init` command) + - ``config/``: holds the :term:`BitBake Setup Instance`, which embeds the + :term:`BitBake Setup Template` (first choice of the :ref:`ref-bbsetup-command-init` command) and the choices made during the initialization. - ``build/``: the :term:`BitBake Build` directory, where BitBake stores @@ -145,12 +145,12 @@ The "Top Directory" and "Setup" directories are defined as follows: :term:`Setup` A Setup is the result of the :ref:`ref-bbsetup-command-init` command, which creates a :term:`Setup` directory. It is constructed from a - :term:`Generic Configuration` and choices made during the ``init`` command. + :term:`BitBake Setup Template` and choices made during the ``init`` command. It contains at least: - A :term:`BitBake Build` (``build/`` directory). - - A :term:`Specific Configuration` (``config/`` directory). + - A :term:`BitBake Setup Instance` (``config/`` directory). - Sources such as :ref:`layers ` or other repositories managed by ``bitbake-setup`` (``layers/`` directory). @@ -173,8 +173,8 @@ The following components are involved to create the content of these directories Build` constitute the :ref:`BitBake configuration `. - :term:`Generic Configuration` - A Generic Configuration is a file in JSON format containing a template to + :term:`BitBake Setup Template` + A BitBake Setup Template is a file in JSON format containing a template to create a :term:`Setup`. These files are used during the :ref:`ref-bbsetup-command-init` command as a starting point to configure the :term:`Setup`. When the command runs, the user may be prompted with choices to further specify the @@ -183,42 +183,42 @@ The following components are involved to create the content of these directories It is also possible to specify the choices on the command line for a completely non-interactive initialization. - :term:`Generic Configuration` files are stored in :term:`registries + :term:`BitBake Setup Template` files are stored in :term:`registries `, and can be listed with the :ref:`ref-bbsetup-command-list` command. - :term:`Generic Configuration` files must end with the ``.conf.json`` + :term:`BitBake Setup Template` files must end with the ``.conf.json`` suffix for ``bitbake-setup`` to locate them. .. note:: - The default :term:`Generic Configurations ` are + The default :term:`BitBake Setup Templates ` are located in the BitBake repository in a local registry. the ``default-registry/`` directory. This can be modified with the :ref:`ref-bbsetup-setting-registry` setting. :ref:`ref-bbsetup-command-status` will tell if a :term:`Setup` - is in sync with the :term:`Generic Configuration` it was constructed from + is in sync with the :term:`BitBake Setup Template` it was constructed from (typically: layer updates). :ref:`ref-bbsetup-command-update` will bring a :term:`Setup` - in sync with its :term:`Generic Configuration`. + in sync with its :term:`BitBake Setup Template`. - :term:`Specific Configuration` - The :term:`Specific Configuration` is stored in the ``config/`` directory - in a :term:`Setup`. It embeds the :term:`Generic Configuration` and the + :term:`BitBake Setup Instance` + The :term:`BitBake Setup Instance` is stored in the ``config/`` directory + in a :term:`Setup`. It embeds the :term:`BitBake Setup Template` and the choices made during the initialization. - It is also a Git repository, that contains a history of the specific - configuration and updates made to it via :ref:`ref-bbsetup-command-update`. + 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:`Registry` - A configuration registry is a place where one or more :term:`Generic - Configurations ` are stored. + A configuration registry is a place where one or more :term:`BitBake + Setup Templates ` are stored. The directory structure of the registry can be any: ``bitbake-setup`` recursively find files ending with ``.conf.json`` and consider it a - :term:`Generic Configuration`. + :term:`BitBake Setup Template`. The registry location is configured through the :ref:`ref-bbsetup-setting-registry` setting. This location can be the URL to @@ -279,7 +279,7 @@ The ``bitbake-setup init`` sub-command helps initializing a :term:`Setup`. This command can be run without any arguments to prompt the user with configuration options to choose from. These configuration options are taken from -the input :term:`Generic Configuration` files in the :term:`registry`. +the input :term:`BitBake Setup Template` files in the :term:`registry`. .. note:: @@ -288,9 +288,9 @@ the input :term:`Generic Configuration` files in the :term:`registry`. Otherwise, the first argument to :ref:`ref-bbsetup-command-init` can be: -- A generic configuration ID in the registry. -- A path to a generic configuration file on a local disk. -- An HTTP URI to the generic configuration file. +- A BitBake Setup Template ID in the registry. +- A path to a BitBake Setup Template file on a local disk. +- An HTTP URI to the BitBake Setup Template file. The choices made during the bare ``bitbake-setup init`` command can also be passed directly on the command-line, for example:: @@ -331,7 +331,7 @@ In addition, the command can take the following arguments: ``bitbake-setup init`` Examples ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- This example prompts the user to choose a :term:`Generic Configuration` from +- This example prompts the user to choose a :term:`BitBake Setup Template` from a custom registry: .. code-block:: shell @@ -340,7 +340,7 @@ In addition, the command can take the following arguments: --setting default registry 'git://example.com/bitbake-setup-configurations.git;protocol=https;branch=main;rev=main' \ init -- This example takes a :term:`Generic Configuration` from a remote location +- This example takes a :term:`BitBake Setup Template` from a remote location (here, one of the default configuration in BitBake): .. code-block:: shell @@ -351,7 +351,7 @@ In addition, the command can take the following arguments: - A custom :ref:`ref-bbsetup-setting-top-dir-prefix` and :ref:`ref-bbsetup-setting-top-dir-name` - A :term:`source override`, and additionally overriding openembedded-core with a locally managed directory. - - A standalone :term:`generic configuration` file. + - A standalone :term:`BitBake Setup Template` file. - Choices passed on the command-line, applied non-interactively. .. code-block:: shell @@ -371,8 +371,8 @@ In addition, the command can take the following arguments: ``bitbake-setup list`` ---------------------- -The ``bitbake-setup list`` sub-command lists the available :term:`generic -configurations ` in the current :term:`registry`. +The ``bitbake-setup list`` sub-command lists the available :term:`BitBake Setup +Templates ` in the current :term:`registry`. In addition, the command can take the following arguments: @@ -388,8 +388,8 @@ In addition, the command can take the following arguments: ------------------------ The ``bitbake-setup status`` sub-command shows the status of a -:term:`Setup`. Any differences between the local copy of the :term:`generic -configuration` and the upstream one are printed on the console. +:term:`Setup`. Any differences between the local copy of the :term:`BitBake Setup +Template` and the upstream one are printed on the console. If the BitBake environment is sourced and ready to build, the ``bitbake-setup status`` command (without any arguments) will show the status of the current @@ -407,7 +407,7 @@ In addition, the command can take the following arguments: ------------------------ The ``bitbake-setup update`` sub-command updates a :term:`Setup` to sync with -the latest changes from a :term:`generic configuration` it was constructed from. +the latest changes from the :term:`BitBake Setup Template` it was constructed from. The :ref:`ref-bbsetup-command-status` command can be used to show the current status of the :term:`Setup` before updating it. @@ -617,16 +617,16 @@ manner. The :ref:`ref-bbsetup-setting-use-full-setup-dir-name` setting, if set to ``yes`` will override the suggestions for the :term:`Setup` directory name made by -``setup-dir-name`` entries in :term:`Generic Configuration` files. This +``setup-dir-name`` entries in :term:`BitBake Setup Template` files. This will make the directory names longer, but fully specific: they will contain all selections made during initialization. .. _ref-bbsetup-section-config-reference: -Generic Configuration Files Reference -===================================== +BitBake Setup Template Files Reference +====================================== -:term:`Generic Configurations ` are the input files given +:term:`BitBake Setup Templates ` are the input files given to ``bitbake-setup`` to configure :term:`Setups `. These files are written in the JSON file format and are stored in a @@ -792,8 +792,8 @@ They contain the following sections: snippet. This is what is prompted during the :ref:`ref-bbsetup-command-init` command execution. - - ``configurations``: Configurations can recursively contain as many nested - configurations as needed. This will create more choices when running the + - ``configurations``: Configurations can recursively contain as many + variants as needed. This will create more choices when running the :ref:`ref-bbsetup-command-init` command. The purpose of such nesting is to be able to scale the configurations, for @@ -891,8 +891,8 @@ They contain the following sections: would expand to ``somebuild-machine_gadget``. -Generic Configuration Examples ------------------------------- +BitBake Setup Template Examples +------------------------------- OpenEmbedded "nodistro" configuration for master branches: @@ -945,10 +945,10 @@ Here is an example file that overrides the branch of the BitBake repository to } - The ``version`` parameter contains the version of the used configuration, and - should match the one of the :term:`Generic Configuration` file in use. + should match the one of the :term:`BitBake Setup Template` file in use. - The ``sources`` section contains the same options as the ``sources`` option - of a :term:`Generic Configuration` file. See the + of a :term:`BitBake Setup Template` file. See the :ref:`ref-bbsetup-section-config-reference` section for more information. .. _ref-bbsetup-fixed-revisions: @@ -956,7 +956,7 @@ Here is an example file that overrides the branch of the BitBake repository to Fixed source revisions ====================== -:term:`Generic Configuration` can set source revisions in ``rev`` to a tag or a branch. +:term:`BitBake Setup Template` can set source revisions in ``rev`` to a tag or a branch. Bitbake-setup will make sure the actual revision will match the tag or branch when performing initializations or updates, and will capture the revisions in a :ref:`ref-bbsetup-source-overrides` file. From patchwork Mon Jan 26 22:27:40 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daiane Angolini X-Patchwork-Id: 79715 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 580E9D19530 for ; Mon, 26 Jan 2026 22:28:20 +0000 (UTC) Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.33757.1769466490661063631 for ; Mon, 26 Jan 2026 14:28:10 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=VmgA9d1U; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: foundries.io, ip: 205.220.168.131, mailfrom: daiane.angolini@foundries.io) Received: from pps.filterd (m0279863.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgGSN3384245 for ; Mon, 26 Jan 2026 22:28:10 GMT Received: from mail-dy1-f197.google.com (mail-dy1-f197.google.com [74.125.82.197]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4bxf3a09xe-1 (version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT) for ; Mon, 26 Jan 2026 22:28:10 +0000 (GMT) Received: by mail-dy1-f197.google.com with SMTP id 5a478bee46e88-2b738854780so5352185eec.0 for ; Mon, 26 Jan 2026 14:28:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=foundries.io; s=google; t=1769466489; x=1770071289; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=sLG6bnyR0Y+dX0CTeYrYDhKqgTpqVghHhOp9tnjx2lY=; b=VmgA9d1UD8oGIQoxxj66utxB8Vu00pmNJbjbvjI7pi8XK8ph1OlMfF5FACAtX9bwBC oEn731F9SHGdFHZigAO6sHWeV4SLEtbfEIC6kYIxx75MKLQKIo1kZ+rUng+/WGXkOMvK 3tUdOQQO8ZmGoQG1idiVZk3Ycvo4QKWyKKGKNYVHNZJK4aOz3fI5qRha1FO3tnWKhggK aORt2Li7nyKCvPiZMdO9FCzS8wcifkP1+mQoPr9JsjhRUL+4M4CUUGa8VshlqnuM7vI4 7MFfl6s+YVsxD8ES0Kh5MFuvVU7g5NjICJaCIwH21ekIYJrAFEvE8+//kfMd3hf1OSlH 7cww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1769466489; x=1770071289; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=sLG6bnyR0Y+dX0CTeYrYDhKqgTpqVghHhOp9tnjx2lY=; b=f5MNpy+ZQolBtaxAAy2hX5vfKsAQaOTXDr41YvpiUzTlPODj4c+2WIz4HRuefpVkTj g8dL98c0we6jH9B925tVFVJ1azdpWArc+MshKH9dZu/f2dWujGq8bCvf8LUKzHkCosq3 LFh4sIgqkDmTLAAXVci+acPax9v6eTtqrlgAFUvfiuwKIy0LVGw6O/xFwl31PMgkPi7/ VCAcIkGXDmeiwsC1PfYOaaOU2nEVtx8SIFf/CZJ2VdqRPIc1Yuyb5It/t7steKJ8t1Sj f4dkRr6rRqNex99J5J/FgAgUDE1YuLZAC4wi7vxanWPUq9XgYBQEypW0b/XwUS3bpOWG qscg== X-Gm-Message-State: AOJu0YxcAdwmNbukMjEi5EAysdIXaJL4ZTUqEbU7FU8fSfs9HflZmCX/ nGrikN53v5fLwpxDQ8pLga4XbPy6FPe9H51fSCpk+LvZiaoW2Lzz2EsHAgcRgc/4zrIzVcxcH12 NFP9Pfdn4U/+JXpdyUDB37xlBEAbDDdJOkka60uMB2ziAtY/pIffvqd/Qt7xz3AdWULlLpjMwyo pniZvWo+Jh X-Gm-Gg: AZuq6aLrMLtFoI7fdohXD5sAYVYyH6GXWwczHDWZen839hvE3OuUR4rtc/26S30wsVU uvKtf7bsJDFWyTG77FftoKD3gqA25S4lZtngJa8ySrcC3HO/YGKM4DCMfAjJd7iy9+lsohS/fjT h+q27SBrGXrjAQ4bN/xWtU845dbGR5iJgrd2ee23KMTQALWGD1w0gZRoUX792Zp+rWdaQXk5G/z GAO+HzucT+BVfhDpN82nFVTqlSj0uMX8ngGyUYA+GcxzJCY/tzUg5AbBOTVxW5c/TXO1hlAPD++ FceqXeA3cgLJuIDNGbl+nm+LWiFGLfg7xJ6QG+jjNuiVbbfkOmhRpaQbHRmjmLmh15rthXMlOY3 bjjIhPvnDXAtf2u0hEGqA6lN4LnvnmcLm63QqQO1RMzVdqW4mGuUMQWjLgZpq91kqQCY3/KvxeS P2Rw== X-Received: by 2002:a05:7300:2211:b0:2ae:51fa:b7ec with SMTP id 5a478bee46e88-2b764508d53mr3559103eec.25.1769466488887; Mon, 26 Jan 2026 14:28:08 -0800 (PST) X-Received: by 2002:a05:7300:2211:b0:2ae:51fa:b7ec with SMTP id 5a478bee46e88-2b764508d53mr3559090eec.25.1769466488381; Mon, 26 Jan 2026 14:28:08 -0800 (PST) Received: from lola.lan ([187.183.40.109]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2b73a6b6227sm15057543eec.8.2026.01.26.14.28.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jan 2026 14:28:07 -0800 (PST) From: Daiane Angolini To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Daiane Angolini Subject: [docs][PATCH 2/5] bitbake-setup: Change the output to match the terminology in the docs Date: Mon, 26 Jan 2026 19:27:40 -0300 Message-Id: <20260126222743.411405-2-daiane.angolini@foundries.io> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20260126222743.411405-1-daiane.angolini@foundries.io> References: <20260126222743.411405-1-daiane.angolini@foundries.io> MIME-Version: 1.0 X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX3XCWPPkD/W8e osMZpJqoEStpPiKN0TNw0h2Qx+P565ZvjoKAU2xftMrPPJco1pNweq7oF7GcbSQ7Df2T1qwtyks TqpSNJE1DKXagZvZvIzZHIsa9tWG4eq1zvgA0vj1yXHmbH05QCC9j9k+kiiXZvEApz+MzkYEq8o Q8XRP3t6OuG+QMh0+21SZIjpx415AHhp/1yBDlD2WBvday98mpiM/L4vlEc00UcWKE5V4miWvAk 9X6OI7KZX1B815juI6oUNmvne4Owck6BkuqwMiDVrGJwSiHzmTZBMpG7E1uvwkXcI8Wthgn5k68 ZPtr4m9rw6lviEnzmFysb1gh7HS43PUKD6OfqFAQVs/atkuBPtcRkbTCN+ND/rKmXwK60XeKRy+ I0RlNUBfRKZfl/uBKb/WXNgfV6B/2kCzuTU2z2g/F6X1lxcEfERdDELbepqp5Lr7+GAgLs7l0yv TWzOyXE8A6ROKUdUlqw== X-Proofpoint-ORIG-GUID: FoTecDFOEsVwAoQpfKql8koj0-hm6Ujv X-Proofpoint-GUID: FoTecDFOEsVwAoQpfKql8koj0-hm6Ujv X-Authority-Analysis: v=2.4 cv=a6k9NESF c=1 sm=1 tr=0 ts=6977ea7a cx=c_pps a=Uww141gWH0fZj/3QKPojxA==:117 a=PIITv4rVe324bgT4salBLw==:17 a=LVY25okwlNza5Yhv:21 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=Q4-j1AaZAAAA:8 a=dmwNTU5nqUlyjdgfk1sA:9 a=PxkB5W3o20Ba91AHUih5:22 a=9H3Qd4_ONW2Ztcrla5EB:22 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1121,Hydra:6.1.20,FMLib:17.12.100.49 definitions=2026-01-26_04,2026-01-26_01,2025-10-01_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 malwarescore=0 spamscore=0 phishscore=0 lowpriorityscore=0 adultscore=0 priorityscore=1501 bulkscore=0 suspectscore=0 clxscore=1015 impostorscore=0 classifier=typeunknown authscore=0 authtc= authcc= route=outbound adjust=0 reason=mlx scancount=1 engine=8.22.0-2601150000 definitions=main-2601260192 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 26 Jan 2026 22:28:20 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/bitbake-devel/message/18872 The original output in the script does not use the original terminology from the document. This patch changes the script output to match the terminoly, this way user can search the documentation for help. Signed-off-by: Daiane Angolini --- bin/bitbake-setup | 8 ++++---- default-registry/configurations/poky-master.conf.json | 2 +- default-registry/configurations/poky-whinlatter.conf.json | 2 +- .../bitbake-user-manual-environment-setup.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/bin/bitbake-setup b/bin/bitbake-setup index abe7614c8..65f0c5eb3 100755 --- a/bin/bitbake-setup +++ b/bin/bitbake-setup @@ -457,11 +457,11 @@ def choose_bitbake_config(configs, parameters, non_interactive): if non_interactive: raise Exception("Unable to choose from bitbake configurations in non-interactive mode: {}".format(configs_dict)) - logger.plain("\nAvailable bitbake configurations:") + logger.plain("\nAvailable Variants:") for n, config_data in enumerated_configs: logger.plain("{}. {}\t{}".format(n, config_data["name"], config_data["description"])) config_n = int_input([i[0] for i in enumerated_configs], - "\nPlease select one of the above bitbake configurations by its number: ") - 1 + "\nPlease select one of the above Variants by its number: ") - 1 return flattened_configs[config_n] def choose_config(configs, non_interactive): @@ -475,7 +475,7 @@ def choose_config(configs, non_interactive): if non_interactive: raise Exception("Unable to choose from configurations in non-interactive mode: {}".format(not_expired_configs)) - logger.plain("\nAvailable configurations:") + logger.plain("\nAvailable BitBake Setup Template:") for n, config_name in config_list: config_data = configs[config_name] expiry_date = config_data.get("expires", None) @@ -485,7 +485,7 @@ def choose_config(configs, non_interactive): else: logger.plain("{}. {}\t{}".format(n, config_name, config_desc)) config_n = int_input([i[0] for i in config_list], - "\nPlease select one of the above configurations by its number: ") - 1 + "\nPlease select one of the above BitBake Setup Templates by its number: ") - 1 return config_list[config_n][1] def choose_fragments(possibilities, parameters, non_interactive, skip_selection): diff --git a/default-registry/configurations/poky-master.conf.json b/default-registry/configurations/poky-master.conf.json index 1de038bab..f248a4811 100644 --- a/default-registry/configurations/poky-master.conf.json +++ b/default-registry/configurations/poky-master.conf.json @@ -57,7 +57,7 @@ "options" : ["machine/qemux86-64", "machine/qemuarm64", "machine/qemuriscv64", "machine/genericarm64", "machine/genericx86-64"] }, "distro": { - "description": "Distribution configuration variants", + "description": "Target Distributions", "options" : ["distro/poky", "distro/poky-altcfg", "distro/poky-tiny"] } }, diff --git a/default-registry/configurations/poky-whinlatter.conf.json b/default-registry/configurations/poky-whinlatter.conf.json index bfa67426d..4827ebe11 100644 --- a/default-registry/configurations/poky-whinlatter.conf.json +++ b/default-registry/configurations/poky-whinlatter.conf.json @@ -58,7 +58,7 @@ "options" : ["machine/qemux86-64", "machine/qemuarm64", "machine/qemuriscv64", "machine/genericarm64", "machine/genericx86-64"] }, "distro": { - "description": "Distribution configuration variants", + "description": "Target Distributions", "options" : ["distro/poky", "distro/poky-altcfg", "distro/poky-tiny"] } }, 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 824b01ffb..7bbe7cc75 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst @@ -347,7 +347,7 @@ In addition, the command can take the following arguments: $ ./bitbake/bin/bitbake-setup init https://git.openembedded.org/bitbake/plain/default-registry/configurations/oe-nodistro-master.conf.json -- This example initializes a :term:`Setup` with: +- This example initializes a :term:`Setup` with: - A custom :ref:`ref-bbsetup-setting-top-dir-prefix` and :ref:`ref-bbsetup-setting-top-dir-name` - A :term:`source override`, and additionally overriding openembedded-core with a locally managed directory. @@ -762,7 +762,7 @@ They contain the following sections: "options" : ["machine/qemux86-64", "machine/qemuarm64", "machine/qemuriscv64", "machine/genericarm64", "machine/genericx86-64"] }, "distro": { - "description": "Distribution configuration variants", + "description": "Target Distributions", "options" : ["distro/poky", "distro/poky-altcfg", "distro/poky-tiny"] } }, From patchwork Mon Jan 26 22:27:41 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daiane Angolini X-Patchwork-Id: 79714 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6B238D19532 for ; Mon, 26 Jan 2026 22:28:20 +0000 (UTC) Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.34329.1769466492498698895 for ; Mon, 26 Jan 2026 14:28:12 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=R0yuGdDE; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: foundries.io, ip: 205.220.168.131, mailfrom: daiane.angolini@foundries.io) Received: from pps.filterd (m0279865.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgJ3V3707346 for ; Mon, 26 Jan 2026 22:28:12 GMT Received: from mail-dy1-f198.google.com (mail-dy1-f198.google.com [74.125.82.198]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4bxf3bg9y5-1 (version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT) for ; Mon, 26 Jan 2026 22:28:12 +0000 (GMT) Received: by mail-dy1-f198.google.com with SMTP id 5a478bee46e88-2b7155ca88cso4558966eec.1 for ; Mon, 26 Jan 2026 14:28:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=foundries.io; s=google; t=1769466491; x=1770071291; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=5fT7lu0B0msCLuinqYTxbPwSZ9ApOFX0xq48z7TGck0=; b=R0yuGdDEE0rjCAXtpDwR88b+YzaLFMks8tHKsgiXjKYRN7xaTFm2aXH+koBnefSwui FFG2tiwBJxqFTiYkk9PDTokw22ZRtLCXKEZ0oErK5n4R4X0zatnyCsXphIbVXCD1hUn8 6nxs2USsH72os+8uKMVoPqqPmIwbJs4OPX+cve2G2lbC9xBKfAKCVKfwOZNL5pFkWStR b+hEEOS+QItCZ47+s2n9Ij+Tq0tz/EQi0LRXSEJjRCXXwaAZED5cKz21Z39LwljODudZ Ups2v/kdOM+vcDgt69kEFcKk+MqFJaQ4UfGHEZhbk8Jyr5tQdNlTMDa2qkP2flnMK85K A2Ow== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1769466491; x=1770071291; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=5fT7lu0B0msCLuinqYTxbPwSZ9ApOFX0xq48z7TGck0=; b=CMR9vOypgTDSm6kBpoAKv2yK2oKzh6Z79sg6yN7WsWwipD/pZF6nOUJkTajMFDIOBI u7dz556iCvIS8qEV/6X3D79IYFWJth/1eKEDSBNjKvKsflAKivlggNiOn9TTOsEjcmOZ aWONKe52qfSn9B+ATWo+NX6mlE5VXOwFMEqNEtCVntUTlgS0gXBNaWqVfwdDipngh3/X +JiDbl4laBFicuNer6VvZgGsIV+xadIcn7K5rCqnON50tpMUD5rw3Hslyo3yspHfA5sG 1AcCWfXJ+okF+ixzvl53EBmQ71OD+RPwjghWWF/AaVD9DycRavDVdGZ0MirIu67FSPF3 m0HQ== X-Gm-Message-State: AOJu0YzwIp3FCZQpKe5KAB0JTXrHvWaP19c+j54PDSQXlPki1appjGAX ahSbDJ+Hagug6W9p4cjwrVzCgPLaVSq/V5bxt8buA++qXPWqk5Htfy1oZxYlH8YFTeTWxoOZCuA fmFvvul8HKsocpeYnZpY0a50gBVdsRtgDSEye8RuetVxjTylEXTtKEs5XZgpYkZuEd2APHTaisN /9Aj+MgtkZ X-Gm-Gg: AZuq6aI2uF6aSadIRaHZitaYAAKYXwUs8nDsVMdmahznMIWZdlXdpf3OmWbpqRPwPLG f/m0KUWwt4/DHMbbEXAmeK+AuiUeHOSujnTCdsibWEUliN7G6p3E+6Uv3YdlMMib6pp+KS3hk9N LuLYleaAYi6Af/w6yeiix/ueGj5eBgD6DOY1B8yhKIK+MDiQhVryZd7I/Yyld4o/Bf9Ed+aoZRE bONpUYfKTR98lMGq95gW7Rl3L1IZrgBH6IFNHMPWjMnyeClykDtlSjsy34lrGjO+db9ZqnuV1nM DkVrSgJ2ePyayqs4dEqSfIg2NjtPujyAg2Wi1AQC0dWxsReL7FlNNBxA9akhHu2xz91KDXzoBag pfQAhx8wsNR12Hsrtdzs4ENCd7qt1SG1DkFV7KbsIaJUg9SWN6SkrpAnzT8RB0xw/ilrskpQb2c cdUQ== X-Received: by 2002:a05:7300:1483:b0:2b7:1e86:35ee with SMTP id 5a478bee46e88-2b7644f24d7mr2750578eec.28.1769466490928; Mon, 26 Jan 2026 14:28:10 -0800 (PST) X-Received: by 2002:a05:7300:1483:b0:2b7:1e86:35ee with SMTP id 5a478bee46e88-2b7644f24d7mr2750570eec.28.1769466490525; Mon, 26 Jan 2026 14:28:10 -0800 (PST) Received: from lola.lan ([187.183.40.109]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2b73a6b6227sm15057543eec.8.2026.01.26.14.28.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jan 2026 14:28:10 -0800 (PST) From: Daiane Angolini To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Daiane Angolini Subject: [docs][PATCH 3/5] docs: Fix leading text for bitbake-setup init Date: Mon, 26 Jan 2026 19:27:41 -0300 Message-Id: <20260126222743.411405-3-daiane.angolini@foundries.io> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20260126222743.411405-1-daiane.angolini@foundries.io> References: <20260126222743.411405-1-daiane.angolini@foundries.io> MIME-Version: 1.0 X-Proofpoint-ORIG-GUID: nrAkPZcjNFhYdnOyhkMhCwLG6wmGH3Ku X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX5gJlKwdjl6ds 954F7+utJkGKs+J4gNIw0znE6MS7737kKnYKLmanjn8YM+5GAiSPJIxCGOMmXpOgQmuf6lvYFKT XFhG2+gvBEDeyi304lTnlSMYKmeGfOAcSeYvwyvvsH3swxD8x6DL9PeM1dTzuMicWGLUW8VnKn1 SGw16VGIM1U6LVL8H6XV4lmiFkJ8TGdOd3Kt5HbjK7lh+0XE8ABt2V5b/WcIC+gFW/KZtyxYKYz DKZdxFotjnH3IDcT6CckJhuzmTR9wr2vtaWkM9EOETMLrv4kxULToKs7ttfiOaJRY+l+HJKjtXV 5JxpcUkZKv4W+brGwFd8Aq0IbmyYsgcxrDdgcsF8QDnVfdWNxromr9axB0eX75fDnXzgbAIm6R2 19+HKq3mbWwT5wwiOVcTJ2yA5XBnXbMofYLmTK6kr9Sv05pgw/ehTDIpcKWVg1icNo01HLkl9+O xWfu0vJNG5q1kq47FIg== X-Proofpoint-GUID: nrAkPZcjNFhYdnOyhkMhCwLG6wmGH3Ku X-Authority-Analysis: v=2.4 cv=AOFXvqQI c=1 sm=1 tr=0 ts=6977ea7c cx=c_pps a=wEP8DlPgTf/vqF+yE6f9lg==:117 a=PIITv4rVe324bgT4salBLw==:17 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=5bBFTqW_sXXhRPb7D7UA:9 a=bBxd6f-gb0O0v-kibOvt:22 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1121,Hydra:6.1.20,FMLib:17.12.100.49 definitions=2026-01-26_04,2026-01-26_01,2025-10-01_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 clxscore=1015 suspectscore=0 phishscore=0 adultscore=0 priorityscore=1501 lowpriorityscore=0 bulkscore=0 spamscore=0 impostorscore=0 malwarescore=0 classifier=typeunknown authscore=0 authtc= authcc= route=outbound adjust=0 reason=mlx scancount=1 engine=8.22.0-2601150000 definitions=main-2601260192 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 26 Jan 2026 22:28:20 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/bitbake-devel/message/18873 If we use the default of bitbake-setut init we may not create anything (as the first default for an empty directory is N). If user does not chose a number, the script asks again for a number. Signed-off-by: Daiane Angolini Reviewed-by: Antonin Godard --- .../bitbake-user-manual-environment-setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 7bbe7cc75..e316ead56 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst @@ -50,7 +50,7 @@ Quick Start See the :ref:`ref-bbsetup-section-config-reference` section to learn more about ``bitbake-setup`` input configuration files. -#. With the default choices, the ``bitbake-setup init`` command creates the +#. One example of ``bitbake-setup init`` possible command creates the following files and directories:: ./bitbake-builds/ From patchwork Mon Jan 26 22:27:42 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daiane Angolini X-Patchwork-Id: 79712 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3AA82D19528 for ; Mon, 26 Jan 2026 22:28:20 +0000 (UTC) Received: from mx0b-0031df01.pphosted.com (mx0b-0031df01.pphosted.com [205.220.180.131]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.33761.1769466496228357229 for ; Mon, 26 Jan 2026 14:28:16 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=CXqUlcJp; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: foundries.io, ip: 205.220.180.131, mailfrom: daiane.angolini@foundries.io) Received: from pps.filterd (m0279868.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgPfK3399324 for ; Mon, 26 Jan 2026 22:28:15 GMT Received: from mail-dy1-f198.google.com (mail-dy1-f198.google.com [74.125.82.198]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4bxdv9gjt5-1 (version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT) for ; Mon, 26 Jan 2026 22:28:14 +0000 (GMT) Received: by mail-dy1-f198.google.com with SMTP id 5a478bee46e88-2b6f0b345e3so23873945eec.0 for ; Mon, 26 Jan 2026 14:28:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=foundries.io; s=google; t=1769466493; x=1770071293; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=yFCEUUgWDqmsNldatAZmr/rljlDaOIPSpMPKTpXcvJA=; b=CXqUlcJp/dDQpwfNfYRCXRvAhK/8wZHK2a1tP8tuAilZ+E966F+6zv/IecBBK7gIPp kUlyGG2AjZ5DG+LO+fSo8gkRapqh+sun4owTxR92C977OLQsZjKs+PJinrXagAcfwt3q go+rSVxCGwtSHfhD1uZTCF9chca07vOkiVuhAfC3JhybQp6AKiQpNUV2ZNz3TqcwbK2w wLaH9vjN9H/5YVsamffRC/MAd40NSZAPNFoo9bTo4OOiXjSmVv6fWKH2EKkLcjjgyuba 4TVD29umUcQSbT3akeo6fYB/Hocj4CpfeESnbXEY7lb/ksdKG3qqyMhrJ+2M6nATRXIh vr7Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1769466493; x=1770071293; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=yFCEUUgWDqmsNldatAZmr/rljlDaOIPSpMPKTpXcvJA=; b=gdNB8u92HkuNo4GJy39DHlM7wAZs9OnUF4F4/9QlX/sxKUezg1LmI/0//DRwUlRI7U HWxnDr8gzXJyIeFke5GsmE/VdroHH/Munt1k2X0Q0uQYWnKNnpFIXcO3/kybkDrygKMB Id8x26RGvyLliTaRLXJYVymKgwxerkDlcnaHR5m3AF5RKNcNSdyun8yBJaoxiFqH2VbP jYkMKGZLHoWTsNTOUN6yXBYCgVhYQW1YKO3Plp613sgQMAuUoLge8zd8qqsKNgMV29yz bVIlsfHtADFAMqS91vcmZhRkQXAizH8vcjFUZs4griJCZBbwLL3TvXrAgFsvT8p9RyQz uiVA== X-Gm-Message-State: AOJu0Ywll84ZRooOz8Bu9yWA7pwckfErPzj2R+2Ar8z8/AC8w9D7n0Hr 0NS/zob8CHgTly2s8rCYSX65pchk1zVQsKnfJGreC2zICVSey+wz2N+G3Fmbt93sRq9yBsJhAJn Pgo+J6uurWgwEAdZDyKmp+CS4Djdh4vQl37IZbIFLFR6u9LwGy5LYP3uFW9UY8+4PCjB3x6plgx 64mxssUSlH X-Gm-Gg: AZuq6aK1IBi0U0r9kLKeG+/6rZNtHCGopTqp9XevBG06w+51I0Zamccb7kw3ld/BQHG jAerZwIVdTBS4vmbPU5atRUXAJ/eH0oSwKR+MvcCf78sxYhcPKMLXpdC1kGiDtOaIeThOx5hY+h L43eJXJjk1skV2fvKIIJ1qQ1KE6lYeJvMjfz2pbzWX5nf2VIAzzfdRQBMSD/f0blxGAYUuZetOa 0UetT99RAVOpQt8hMr+AKe67TbzGMImmVwOtG46jgMtz9B1t7bN+cEMEJaqeOXSUXzt9rdmlmhw xcop+4IeGLYKpODzGyu/zgbvBaHr8KP/1oTINrvY5R+X+WGGUGbq3oJDldOGrqFK2RCPZjmGkDU JXiWW4hWtI1X2R/HKlpm5rEZcEUG1jEBu4ElWFzADTXXf/qe63929Vf4Qs4GslYrj7zNO4uPzv5 btwg== X-Received: by 2002:a05:7300:cd9a:b0:2ae:5ab4:e932 with SMTP id 5a478bee46e88-2b764628d6bmr3226025eec.43.1769466493498; Mon, 26 Jan 2026 14:28:13 -0800 (PST) X-Received: by 2002:a05:7300:cd9a:b0:2ae:5ab4:e932 with SMTP id 5a478bee46e88-2b764628d6bmr3226012eec.43.1769466493101; Mon, 26 Jan 2026 14:28:13 -0800 (PST) Received: from lola.lan ([187.183.40.109]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2b73a6b6227sm15057543eec.8.2026.01.26.14.28.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jan 2026 14:28:12 -0800 (PST) From: Daiane Angolini To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Daiane Angolini Subject: [docs][PATCH 4/5] doc: Add the term Variant Date: Mon, 26 Jan 2026 19:27:42 -0300 Message-Id: <20260126222743.411405-4-daiane.angolini@foundries.io> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20260126222743.411405-1-daiane.angolini@foundries.io> References: <20260126222743.411405-1-daiane.angolini@foundries.io> MIME-Version: 1.0 X-Authority-Analysis: v=2.4 cv=OYOVzxTY c=1 sm=1 tr=0 ts=6977ea7e cx=c_pps a=wEP8DlPgTf/vqF+yE6f9lg==:117 a=PIITv4rVe324bgT4salBLw==:17 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=KQc11KMpeXEtGPe8wygA:9 a=bBxd6f-gb0O0v-kibOvt:22 X-Proofpoint-GUID: 03vyedUXCqK2ydIAHVdD5QQSxAxYbtqA X-Proofpoint-ORIG-GUID: 03vyedUXCqK2ydIAHVdD5QQSxAxYbtqA X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX1/CuerplZRWo ObYEAOmO1FE+G6WEutsBklh/PIgniTAgS8MpTigFCqpLjmUJw0eeh0ZMWIw9LB19YneYP4aebS9 Sr5WBUdCnBeRvTJYNxf6fM4twj50kKOZKoqiYcRODcGWtn92jB9p7iSgBUjYVR6kLOsjjfXuWrm VDmgIxbfOWq0qfwv+Y8XC6AOAmvftB773TPRDSbdc21CeTQKQsxIwq66nRuRqEd9HSpkIUaLe5u Nq1IZQbdgkYXSGYKD5IyCdkM1hOTwDcMB571Bja5+gGBWWhnnvtrKBRzuN6b6wVaDDNTZbaV9o9 rZANVPu5/Pb26Rgpd+DGWi02PN2C08oDmV/cgpZnkVOHyx6OKuOJ3UpRmGLLAtTUDNXFgSNXCwf PvELpAgQv3Hh+qaeTwERnAtdEVujnL6Hybl7KPovRYuAQ15qASgUYj1Qed7re2wUJ3Ecs4B9xRS QfXUR+ejLNQ7i023zww== X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1121,Hydra:6.1.20,FMLib:17.12.100.49 definitions=2026-01-26_04,2026-01-26_01,2025-10-01_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 clxscore=1015 priorityscore=1501 adultscore=0 spamscore=0 impostorscore=0 suspectscore=0 lowpriorityscore=0 malwarescore=0 phishscore=0 bulkscore=0 classifier=typeunknown authscore=0 authtc= authcc= route=outbound adjust=0 reason=mlx scancount=1 engine=8.22.0-2601150000 definitions=main-2601260192 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 26 Jan 2026 22:28:20 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/bitbake-devel/message/18874 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 --- .../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 + 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 ` are stored. From patchwork Mon Jan 26 22:27:43 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daiane Angolini X-Patchwork-Id: 79711 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2C64BD19526 for ; Mon, 26 Jan 2026 22:28:20 +0000 (UTC) Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.33762.1769466497019039431 for ; Mon, 26 Jan 2026 14:28:17 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=I78DkQ9c; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: foundries.io, ip: 205.220.168.131, mailfrom: daiane.angolini@foundries.io) Received: from pps.filterd (m0279867.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgsMP3481823 for ; Mon, 26 Jan 2026 22:28:16 GMT Received: from mail-dy1-f197.google.com (mail-dy1-f197.google.com [74.125.82.197]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4bx0v32tdg-1 (version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT) for ; Mon, 26 Jan 2026 22:28:16 +0000 (GMT) Received: by mail-dy1-f197.google.com with SMTP id 5a478bee46e88-2b715b26fc3so6717275eec.1 for ; Mon, 26 Jan 2026 14:28:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=foundries.io; s=google; t=1769466496; x=1770071296; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=dY2krERVNMW1rY9Sl0iRg3yaPXKyr9CUfjCuYN8uong=; b=I78DkQ9cwhKg9oWaAhm+/wWA280T+IdWbuOXD7gQte47kC0ZV4j6rApdtk5W7NNlra nuD62C7Am4T6a71Mzmy99dMf+qPx/H5KrVLCbLDieezgbh76eilkl8heJ912fnymzSTZ v2a4qOG/XhIBpWj5pz8Q/OtgPrzsLRSTg7qok/dDHQHh25mkcgXdZ9X3jZy966/fVCrl wjX84jAOy3vSqBFdyQA/r30Dga3Xr1wRjahhtHPW5Zf+1R0J4zSgIiLYG/igI5eD8Sj8 XVj4C5bJ2g3tgqy9I/rj4JhRMl4vgbRIUH7cEwbsZf6rXrr7ISTPq6fLyBABDZNH3ghq tBpA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1769466496; x=1770071296; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=dY2krERVNMW1rY9Sl0iRg3yaPXKyr9CUfjCuYN8uong=; b=DTqMGxXn2GWIpnU1HoLw/AYP2gdtZRo+x6zozsYcjnaFDjpw7a+pJyfipwzXdb32oX l14Ac98MBn0m/5aMxvyZPyhaKCSfDE8wk+4e/EpfG+7ZzRFQ6nGDZQ07MRha2YCNM8Wi oMt8Ug2gc773DLu2tNqSKcpk7yaYlSR9FrLma8sRnK82omcLk8NJFkRq5jRp6csWyEKX S/fDLLfOHtjnFKlZXtYR8tJ1LkBxApE7QKUC0gRW6oq0zPnV0IXpxWvxjABKL0mlxuDQ sf4H+HCAaAavdrB7YwE1yNOEgIoxyif6/SxUTYlE/CIujuxkTtUzrMfnChhYTJL67lti PWVQ== X-Gm-Message-State: AOJu0Yx+O7+PMnXncDosKEgwwOHJJfbWW0xgCUO/CsgtnYIFG8gtSSq1 fLKfArWsgFGw/d1TH3wj7iNVDdBfp7kvzTYjKuUfXp+Z1eNzpNwg0w2a6Drx8aZISCwhavs0g4s DL82H7ACL9LPeiMCH3yZ/647yLsplwE3AfISXa7esJdek+1G4fsb3tKO+chh1bpnKcdCdep9siF TYP4Ol3rdZ X-Gm-Gg: AZuq6aJ1flWnavaBK6yEw/bfFYR1Tw4DgSD8Q1OqsC/PnTSzEjfOxepfH/e/3dl8oLQ D8rQElHuVSOClP9tP/resTnDMoEfKDrlpvE+3zy1vs0IWGV0t5V3hUFVEK1oOJFictIkx/l7s/f h+CMZg5oXw4ZHrVdEipTLX2Sv9r7TPokkUcX65IlSHwn09GyCMEu21R2iUAvDmhTXy2keetpERE 3aL/dQ5bIsPLB+KNwDuEeKyrC+nv6/HQ/DfV2ntcSwU/0GSgf2OfTwklw7FrKKnxyx7NhWPktn3 gd1PW3yTdBVWf/5cJ9JnSBHZcJ/PXBRLhIdwJakh6pngnCN5ZjMx1XQ5qVy7z6P+s4yXIpXiEoQ 4f02QN3DXXK5U3swGbAkvWVqYQBB4JcNe0jwXDiJpX/uZykc3Gk1KvGq2rcYBWlq8ZR2df7dsSH meDA== X-Received: by 2002:a05:7300:7fa7:b0:2ae:5f28:eafc with SMTP id 5a478bee46e88-2b76451ac6bmr3218202eec.27.1769466495750; Mon, 26 Jan 2026 14:28:15 -0800 (PST) X-Received: by 2002:a05:7300:7fa7:b0:2ae:5f28:eafc with SMTP id 5a478bee46e88-2b76451ac6bmr3218186eec.27.1769466495337; Mon, 26 Jan 2026 14:28:15 -0800 (PST) Received: from lola.lan ([187.183.40.109]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2b73a6b6227sm15057543eec.8.2026.01.26.14.28.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jan 2026 14:28:14 -0800 (PST) From: Daiane Angolini To: bitbake-devel@lists.openembedded.org Cc: docs@lists.yoctoproject.org, Daiane Angolini Subject: [docs][PATCH 5/5] docs: Fix sources as required Date: Mon, 26 Jan 2026 19:27:43 -0300 Message-Id: <20260126222743.411405-5-daiane.angolini@foundries.io> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20260126222743.411405-1-daiane.angolini@foundries.io> References: <20260126222743.411405-1-daiane.angolini@foundries.io> MIME-Version: 1.0 X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX8faIjLgsBJMS 2n3QFSoHiHUvyxfV4gbJgwGNIUu99+aSxNPu/iDnY2Tcc2cAMIfVS7c2YJxrpfzrO6bVVCZCcdd ftmPwlTlo9NHAdpcqHMgmqiHIztDyjKGTcdYmWA3SP09+5S31ZOUWJEfU7xCTYz+cuy5UIDrZb8 I6ed919/7q5rXJK8v7PJpiTDo7GiQlI9WtL2wZYxhsXDBZiB9aKfwgVQK5s9Ckqhlnxqjw/oe9U dcWyvps7JrfrSC+EJ0xR2O23R7/DwV9s9b0+yMrACkbzXuLu1J/Gy0XmXeLtQEJDKMhuYT96aC5 WzLw09iKZvY3+fkooshBg+JZpVAUTjEVUC8DSrW8iY3jck38p8lABvBxMlI5iN/JuY8+tn9WKNs s2Qr0Ia6t0H3VhtpXljLR7FqhKyoX4HWcUBxYnqodj/7cGfZTHPLqfKgflD+dM2FSYpC0HwByzJ qxMlgrV8bLBA8fQkO0A== X-Proofpoint-GUID: uyvD8f7h7N_rjKQPOgMiJ39ONV8S3jqa X-Proofpoint-ORIG-GUID: uyvD8f7h7N_rjKQPOgMiJ39ONV8S3jqa X-Authority-Analysis: v=2.4 cv=JYyxbEKV c=1 sm=1 tr=0 ts=6977ea80 cx=c_pps a=Uww141gWH0fZj/3QKPojxA==:117 a=PIITv4rVe324bgT4salBLw==:17 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=CihtY_vhn8dth2W4YvEA:9 a=PxkB5W3o20Ba91AHUih5:22 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1121,Hydra:6.1.20,FMLib:17.12.100.49 definitions=2026-01-26_04,2026-01-26_01,2025-10-01_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 spamscore=0 lowpriorityscore=0 adultscore=0 bulkscore=0 clxscore=1015 impostorscore=0 phishscore=0 suspectscore=0 malwarescore=0 priorityscore=1501 classifier=typeunknown authscore=0 authtc= authcc= route=outbound adjust=0 reason=mlx scancount=1 engine=8.22.0-2601150000 definitions=main-2601260192 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 26 Jan 2026 22:28:20 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/bitbake-devel/message/18875 If sources is empty, nothing happens. So let's just not say it's optional, and let's say the minimum is bitbake source code. Signed-off-by: Daiane Angolini --- .../bitbake-user-manual-environment-setup.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) 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 700e02216..5d6bcbea1 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst @@ -671,8 +671,10 @@ They contain the following sections: "description": "OpenEmbedded - 'nodistro' basic configuration" } -- ``sources`` (*optional*): sources, such as git repositories that should be provided - under ``layers/`` directory of a :term:`Setup`. +- ``sources``: sources, such as git repositories that should be provided + under ``layers/`` directory of a :term:`Setup`. Although the list of sources + can be very flexible, at least BitBake should be cloned to generate a + :term:`Setup`. Example: