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: 79716 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 41DB6D19521 for ; Mon, 26 Jan 2026 22:28:10 +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.33753.1769466488722532222 for ; Mon, 26 Jan 2026 14:28:08 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=MA8P6zhO; 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 (m0279864.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgEbi924862 for ; Mon, 26 Jan 2026 22:28:08 GMT Received: from mail-dy1-f199.google.com (mail-dy1-f199.google.com [74.125.82.199]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4bxadps9ws-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-f199.google.com with SMTP id 5a478bee46e88-2b6f0b345e3so23872986eec.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.yoctoproject.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=MA8P6zhOzboRFZH1B90SK/KxE7gUPX0/Fhv8SIkTTLbPRioRaorpGNwxHejWdX8hI2 tQZ865+Qo1iRCyXnLy57j7huFWdJycfyvBJwnVbhGtYFGpf0r+cpDvjLRZwUVmhBG6B0 9ntuAOJFzmnXwh6I7YKVwwaM//hjBY2uxpCkfmVSfF2I34QZ1QUa5uJeFlzjYkxt9LPR efYuiaX1NyRna/eAcGTAwmshRnsf0xfPFwFx9YEchJyUsRqGYnH0FeSycEecySkZYNL3 wic+g+AIc/HIUt8G1yehOxFbLs1ZH1BqE+sNUvjRNJh/Npnnr+a86oCrsSSaL/goTAoz H7XQ== 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=Q0ZmfaO50qg3K1UW6kmHA69k0x4ibH+f+p9sQOU3RwO5PCzGdQnMl+J+hMpRGZN99l 8RjN0dbaMadgC9nDwNSV4Q30hUzFu5lDP3nnq1SGBzXVWmwJ/6aiMDzbSbrLyciXgaH9 GSiamIvbzepQU0PL3497PAeOD0HAQquFPj0ZDFB2+/eQCStIrkhieWKIExaad5oQmpyN niuGyIPv8OklHr4nvAnFyNXw6mmjKBRrPRCD+4o8kWh12USrSdno+Z29c95YC7x+DAV6 WqWeoDCO3MzHCJNQfcX37i5anZXUYAv/o2/z/Sk6HS5wcJDFIK3XDeqFUlCO8a36fB77 Frzg== X-Gm-Message-State: AOJu0Yx/wvoIXqJ7LW4KgzWkoGTGljk4vijoLMa/KOZFE1/jSUpEzWj/ 80YLKTxQinfdLEMIi0UuJk4jp8AvgMR7AnBw0CNscSk+rLXXUYgg5UD2JVlqnAmI4pdNZ64UQts 2bldSbDQwzDB9CphoLRijVtthAyNap38a800OcSeR49ToAKFiJqEfM0wF4oPQpRTGBsbcsBGb X-Gm-Gg: AZuq6aJHyiN2nV+scanq/pyxoXOzyMzXFmT7np0po8mWRh36vKdx6F6kJWJZ0bq9x/t 7HA3Q/YyZAokkl5R3flsstY6esgxRhuXMVygPE2LyPyC5cC3sYcMEwSmpfngoHs36pyd0d+/63S CRrpo944Y5rzfJ4O8c++7IQVsN13MGUzJB2S3TxtWqEuAIkAYfFuumZzPHxRk9a5U0dOj1wmAoI KHlmZOITYCyyfOjJo8FHsyW2yL/V4WRy91ZV3u5sjwt1UNqoJLPNLMSjiaY2osGIvOMADAfzX1L +qLuv78amvH0D7oNAUHXCV+JwwX2UJlAsPMiSrr9+YxcQnutmJEafkO8jk/yq4pgrCvYIZJS+Hy MOlvsR/c7CUQNJQNV9zJxRkO+2xZpIrZ/zZ90waFghKYsG8E9UU705RZxBNvZbfIpBJP3dYkedx tlRQ== X-Received: by 2002:a05:7300:80ce:b0:2b7:18eb:a0ba with SMTP id 5a478bee46e88-2b76451543amr3239759eec.36.1769466486900; 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-ORIG-GUID: WCUkgQ5y5ri_rPi5OkS46bm2QUWn4dG2 X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX/JjSk3KET2Yc sH3BunSKKZIrMZ+6gzuZ1mBuUpUQNShtwqeVB8PT+cM0w1W/vEWwmf1LV8rhBiQ7tdl8M/QyvR2 hr/afBEhs32cg3WHHR5325MLuhIJAw9D32XZjt9NKYY31Sni/Kb90ufJoekJgic4SJMdG6/YGnH Rg8rhgJzhqtN1ddRI4eWXAC/3exOKIKf05ZD1R2wmZJzQGkM1781ZwDuOHw6iddiG0iMbHBFrLc TuwqyoBv2AEAyhI+KdDb88qyxBJ5ur79ngdjgQFDtYHtCzWAFDr+QiDiYaIBjDINA9ocegHJ8Fb Aue3t7GZL/uQdkY4JJ27rwk9pGSE+S1437BAHF3pODWEe+9lmfqdV6AAIPK4JcGMnof4L6J3pn1 dE9m2dPkgG9sDJQoPXwXGa9sA8gXpxvIC6lYLi/MRy25LTxi2rWGQpKDX0/jK8pmCKCpCV7LPDi 7JsIgP66aRVktZI7pqw== X-Authority-Analysis: v=2.4 cv=GvdPO01C c=1 sm=1 tr=0 ts=6977ea78 cx=c_pps a=cFYjgdjTJScbgFmBucgdfQ==:117 a=PIITv4rVe324bgT4salBLw==:17 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=A1X0JdhQAAAA:8 a=Y_ynoO3N8lTnrvQkgkkA:9 a=scEy_gLbYbu1JhEsrz4S:22 X-Proofpoint-GUID: WCUkgQ5y5ri_rPi5OkS46bm2QUWn4dG2 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 priorityscore=1501 malwarescore=0 spamscore=0 phishscore=0 lowpriorityscore=0 clxscore=1011 bulkscore=0 impostorscore=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:10 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8653 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: 79718 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 324BBD19525 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.33756.1769466490490639925 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=VOOVDWAp; 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 (m0279866.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgUCf2942983 for ; Mon, 26 Jan 2026 22:28:10 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 4bx2682p8a-1 (version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT) for ; Mon, 26 Jan 2026 22:28:09 +0000 (GMT) Received: by mail-dy1-f198.google.com with SMTP id 5a478bee46e88-2b70d8095daso4727765eec.1 for ; Mon, 26 Jan 2026 14:28:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=foundries.io; s=google; t=1769466489; x=1770071289; darn=lists.yoctoproject.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=VOOVDWApb+E7tODnSYouc780A8CBZT0d04PMmKPag1a2Frzhsb1HsdqvqwLdS6hWWp EHlhoSeW4Zziu1437sBLZsMPhmmjG1EsF1keKB2TZo22NucxufLCC9tNRXSHy4TBdeQh EgCEvGBnfX23d+rlCIRGayDPWtM4muYTGL8VGOeN9eSjsI5u8+JW+w0uD7P0FHF/Rrbe e9ZkjMtsqQyS9hBxnXo9+XfL4HP7SXn1KpqfCP5x3bicwtogl2wydAjumGCe5N9QIGRd x+cc92q5kNw+Ty4hQi2Bpy/iRUpszx+uaugZ1yqZLGeQs5+kRPd7iIL2NHH1/y688nMy xlOw== 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=dc6plzNwsXNg2eTFEHUI+cp0v9Ts1PT6mJ3AywTAAeLkzMOGi8KiY9Sl10OwXDUslp gdRBBk0TwCI9xjcEliJaEmimBn16r+MaXc6SGt4cCW6k6kHgxUzAamzdrUN/SesaR6zr pRdGuvdmyOEPHDRRJCHy4kFgHnbmxD9INp+/4qGsLbtiK2jTKywTbIp+peqtHCRoXglW wi4NEuMSQen/CfC7p3QNFhjYwKG+eSwtjtKBVDzZqJGiCQEgeA3Fz1dlLYTOe5ApKO0Z KccVx1Mo1pNa5thXoWH6+wnuencEKK0R6Na4+bjT77anAKUcnk9txraLtrHP7hmc2Hhd mniA== X-Gm-Message-State: AOJu0YztpW54Z3H+ZeDPo+WM8AkkMBkqHOWf9F7Nc+EyHmNDzQsofmqu lJRoGPmYCWl/EePhH5KgapUBfXl1eAQHywKRJCYulKk0OLIYn+ghV9vy8pSweuSItTYGHQyvWeW AhcM1xpNchMABG6vZD3p6EgOLIBm9ieK+tV31JcejM5tl8wm8D8AHCuXTWa6gyBNA5MM9a71r X-Gm-Gg: AZuq6aKMGtSCwjb2cAmMmuCad7ZAt3XiNxrBK+YtyckbnQoAzKSpOR/LFgUkr5D8uBX 1FZuhjwTvw3q3gNQDKzFCw0sLfPumHBI/85RCKl5E+GwINH+oEGPt4SXsZvCyd+jpCwUVJ+oCMW tRTu9fjHN5Sm54d5rOLUYFLarIc5wxD9VLhrcX+EIh9tY8rXcpHdwDmYnE9sYlh84O1Xpf0NjHx j8oJAbkhm08DYFgfq4tOHjnmx1fH3/YpsrlXCKHfzBlvZz4jvHB7W3TMKCIhvzZQSLImqahKaVa en5vjg0cqYmYcemlFqyRRmnrdUYQYhDnKyM4sZjYf7QdzW0z/QNTkQ++rXIHel7tlx8e4lgK0j2 TILoF7PfxQFS9ZCy4Q/MNupZdBpDI4byLzUTm7mseY32QZlOpqr5sjfNT9PdJeqstsAJM6m3qRx xihA== X-Received: by 2002:a05:7300:2211:b0:2ae:51fa:b7ec with SMTP id 5a478bee46e88-2b764508d53mr3559102eec.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-Authority-Analysis: v=2.4 cv=bIEb4f+Z c=1 sm=1 tr=0 ts=6977ea79 cx=c_pps a=wEP8DlPgTf/vqF+yE6f9lg==:117 a=PIITv4rVe324bgT4salBLw==:17 a=LVY25okwlNza5Yhv:21 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=Q4-j1AaZAAAA:8 a=dmwNTU5nqUlyjdgfk1sA:9 a=bBxd6f-gb0O0v-kibOvt:22 a=9H3Qd4_ONW2Ztcrla5EB:22 X-Proofpoint-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX7DVyS11FbuP8 GuXhAkhTpmxwe+bEYH95CiB12d+9QYKse6cvmHoUpt+UjfSTfwFR+DcKN3E17t5j1TxNDZQOf/8 rQkCz99BzpMLX/I5D7vx2aqJDnyXTFu8tWbqBwPNvozXo6ZhVDtE8nba+RLHz29TM0RVT0hofXd N5Awejar1/Zof7OW093q5a/7fWPReNfrvw3T8x+k32C0iaX322ISg465+k1o9I3NFDR6ulWJ7oi QSASWmE2DgCfnqt+nBctnwZDjMQMn2eGpkZi+RRmpHN9bjKm6MVsufEHEOv+cpiW2i7Zq1fC7CT 089qzoyN8lvk9abrwT0LA0F9j/z5NPc54REd2rbKx173eMR98uE8JFU70RBS0EeADcIVL0PD+Hb w+oSmpqdFrdwVmj0KNJFLDmJ3u+EetDPU/8ytLov3wbawXz2Z/471vu9ZbyrsZP1T6A3ybGdoOM Aj22uJFyVeQQNWcZETA== X-Proofpoint-ORIG-GUID: zKqrLxiVhsrOLi9HZt6lmH6I5Ew70WfK X-Proofpoint-GUID: zKqrLxiVhsrOLi9HZt6lmH6I5Ew70WfK 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 bulkscore=0 lowpriorityscore=0 malwarescore=0 priorityscore=1501 clxscore=1011 spamscore=0 impostorscore=0 suspectscore=0 adultscore=0 phishscore=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.yoctoproject.org/g/docs/message/8654 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: 79720 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 4B5D1D1952C 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.33758.1769466493386553784 for ; Mon, 26 Jan 2026 14:28:13 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=VLXGDfnX; 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 (m0279869.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgJVY286726 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 4bxdva0jtp-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-2b7155ca88cso4558963eec.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.yoctoproject.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=VLXGDfnXv0A+mqZr9Zv8gPjbZoIrs7mw45+o4qDVf3plgv2WN5NP4WdFXDIY7LZ/B4 vJupf0pKFTlwpoWyrnTzrPpOBCdlBtBSEj0r5F6GhjMblhG9xz6CatR3oLI0mQLiBxub uIQamNTS3uHvSfbgvNV3tRXU9BrlTLMcSrFF65WoNkBmiBj/XYzB20fSLVMI/zFbiUoR 0jcAL2tc/znF9KnVRfC776D2hhovBWp7xuRUc+R7VzYP5PZGO/TqjRdxHT/0b6hCc3nh 5pjgcsTdU2hFNhaDrMMTCWcmECK3E7TdsX5YL3F7QBtd9XlfO2rD6dlaB2d5LKAj27x3 Qmbw== 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=wcVDQQ4nQ62pQd2l9BfXZeY+3AI/wO0XbzAcXHHY2bGu+LMPZPQG4HUp54TB5VPnPb IQQJl5AKoHWLFPKhAnh4d8S/f7HMbufnBTjgqxx/RDC6yKQQCk3q71/Q00FOSMYY7H4k xDKPtvVAHpkD4f0+JsiCeOH9YYnN9J7A3k1/gXztHB4/3+vVZqIAlNsGvipedHaRL09s e5OefrSgRl2ECWY98OlZ6KG+cYk2oOZfaZBxbpdRIfXOewTDlF1PfqO2ZG2+D2RzdIGH lr5MdYzI4vFKR7qx781dP3eNB99F3wutQDIJQ/EY+qHDIMcLFA7HXbkh6f6oKsew63n3 nF9A== X-Gm-Message-State: AOJu0Yzoglnh3x+Gtb3tnPSxzqEKLlF59LAhES5QO9GekOcMQKiroHRq RPQCu23lL3+YBxKHyRx844+FqSKbjbqmE8lAI3AaaiZHxxYfK1s0DWWsXf53gen0LtAhciPdXrQ t0BPAmaLN9HRArNdknjvCKzu4vK/EBfFPoEtM9pHclFeiw0+mj+kTuHpvHPo82HwLALZETRTy X-Gm-Gg: AZuq6aKC3AJfXhYOPFm4GHmn0ZykMBzyp0mTiIc+jrP/CKojaK52ksK4NIuLbNMDKFC SNZ4psGztnL6dbT5xMA9yQWPGVqlnXPS1VnM4BTiN9uTFn/GNtt9yzH0p6V061gyabwe8Q297Fq kaqfYY1PK33rCm0KxrpELkf7c268L7utz/GV/LHHO8vayiV+NjpDmDYx3Ng7JnjVdhG66Twb3Nl udMaH4JDTsuHfhBsGSEZYfSrEn3E67wwUkY7oR4O97X/2DnrqXQg+vI71SPtHawLJPj7TzVM8xf i0KdD1cZzUNSx9z/9L51qZ55VHfALPMB+NQNSxKkcyjjmyiZRbdQu1p79Ag6f4VrXW/liRsSMN/ c8/ag2pzZHuVy6OzFR9kT6EJIKNYltfioyqZgJaEEK4CMAXM3p+6NVPtftzOK66+Ud3Cnp+cEOB mGTA== X-Received: by 2002:a05:7300:1483:b0:2b7:1e86:35ee with SMTP id 5a478bee46e88-2b7644f24d7mr2750577eec.28.1769466490927; 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: fH1kCZTlzt88r_4utEJdFdiJvoa_Dfbq X-Proofpoint-GUID: fH1kCZTlzt88r_4utEJdFdiJvoa_Dfbq X-Authority-Analysis: v=2.4 cv=I+5ohdgg 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-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfXxD5FXiJUHN4e iXppAcFJX3ZjhvbfEH8VuXyYSBOyY71LMnIZHkd0Zww3arfaglfIUkASek0Z9LvGVPzkDzeXodl SqTcSHO3/cAaN4p13AR56NHi5jm5QdqRuFFa8IMPexEeUz83w+ogkpwLsHKGrJu0LZgh7r+ItV/ 0Y/TKaxcMeo4DiRK3zuHuk3Gz4gm9TI+c5tR+3cWV9WIHaCd7j9E8fxK5CSOXYhF90i3gVhiRjU kfhdKT5EsbHYCYCfB2C7HyOGAGGFDhUIz0CobLBARZb82gKjqacZmYqH7oh4mTA7Oa08X+xHAmy JsN+jlHGJ0aBzmMdOuENj2bdfHieZ0V4pOOPGV2afWvYXxsHgBELJI7xWk75ynRjegos6tGKBv3 i5BcH383pCoFyE2CUomaCi/jHSs/M5zFW2X9LvbX539AihnsryTAwlnwKhGvcZfYk1JSsQS/Lps 55vP2KNG8Fqb1GUgjDw== 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 adultscore=0 priorityscore=1501 impostorscore=0 lowpriorityscore=0 suspectscore=0 bulkscore=0 clxscore=1011 phishscore=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.yoctoproject.org/g/docs/message/8655 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: 79719 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 3F5BED1952A 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.33760.1769466494772015251 for ; Mon, 26 Jan 2026 14:28:14 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@foundries.io header.s=google header.b=WJ/DODxs; 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 (m0279866.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id 60QKgUwW2942978 for ; Mon, 26 Jan 2026 22:28:14 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 4bx2682p8j-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-2b6f0b345e3so23873887eec.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.yoctoproject.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=WJ/DODxsX3jxi2YcPZiJhtpYjHsv9liWl3gcOJuoACV5xN6R6MPchh1MUshYDFExzl RDxkS1ZAmtAFPamrVIYhASbHshxUIIARbONA+dXjGtIynmeEaFYamKNZrLsco6S1W7Yl lrEy1P1vDHbk3OZyKLa1AVbU/0QqVIh9VaTEQv+64vxdUWa1Iq5fk9ENv4mjcl01b0LN 29FEePxnKnUpkRanJHUjMf6uFRqkGnhYuN27cTHCuHdoR7CEcHqciWoRukesUGu32Rcz QHboKW1LU79CxPDU6ewbUyPzuIcL4JpXVbikOOawjFSHGWASWNheQQpTt5c//eOm7srm jx7Q== 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=O8Bm1mHkCvpIqgvyQUS2kqxFKv9lGqE4xa3qlMbVpTW42X/l01WwrOuvzRPaZWyKbz wKCZ7NiP5YcagiHIxxcy+10yc/R5SlHJZrXQYAyBdDFB0mbO1nWjOAeiqde1EDRXqENQ x1JQO33zdYyE9+KOFERqI27fg9c5+lxPefuVdsoXODIKCv3VRQx88gH5HkrnuMbQhzhk Ca/aMSzIJCF7F/2gHtJI7USZ4knq4kpS0fgpV4EjeDZuoW0nE3C5E0/og6r6lvPOXs2f rDITz/waYYlebh2aHtz0BqUpTa5mpFRzowDEqV2Ua7Wb14tjgGMwHX6LMwMJ/lct3Yoi Tviw== X-Gm-Message-State: AOJu0Yz5LKrisrUwtgcbWEpqsr26qODuQV3gOqipBc64XWDQrehj8xDZ +JYa+t3iSS0qorU3YhKLG4bRfBzdm14DsX2gc5CulKu4/bGN9+z37E8Lhe44wWgxgnOmMqlesDC AHMGfJtae3Cus/Xb+SxNBWcD7gsWaoOjt+nvngMUd8H3eeYvcOFz/hBnwPRPbf4dmpMq6/MZp X-Gm-Gg: AZuq6aL9004kXXVd0JNjwAQmV2joDAldnBagtzj4g0/6nKiXmy+LhvzdFwP9GGqvOIB /SYgix+qa+HOfPVQCpH9XmowobLAlhSeOz7cMgR3zjMYKJd+MQ0rQ+H0KQOSqgpYaTqCcloYphJ e3GYN6lNVUhHiONVa43VEfTk/p2LmzMvGxi3Bue9M8ItDWxrWq8UiSMY5tMyHn2W+ixgH7skTIa dZgXq4CedQT+p+0P65+Ce57A0SNrBS+HhYu7SG55ljdZY7VKM18p/zY6FghADlXwvj9ssrdWfKj AP23LJvw9ihq+17W1EIrtHURrpzJZTrPgGJAE4jr5yZpP7wI15FozajqGxLFczWYlwVp6j3NYcB sLa2syoNYZZKgP0jMDFFUXrfY1vtx3U1YnXNSFX0DbdFniehvYdspW1PKD2Pu5ofFgoUv04jyVn UvNA== X-Received: by 2002:a05:7300:cd9a:b0:2ae:5ab4:e932 with SMTP id 5a478bee46e88-2b764628d6bmr3226024eec.43.1769466493493; 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=bIEb4f+Z 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-Spam-Details-Enc: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX8KKR8CMkvCkI G0X0dgmZRpjsMNyQhNtAFBHiWMZpg1qbczlFiq402U7xS6RcanB3+KwPeUbvbWyFI7FDadW5cwa kUe6Ws8yG4GBgnKE9LSo46zmGfuXM8Cn2/JeAchIkd4XXJRyfz042NxM2YWchEHCy8hil8Qo5bh WDTVgtO0LIc1gfgnGrZQvcyhDxh7iY7bqWZWscMjW8biN5B8OB1g2nvph/T25TUhuw8ZOGTxziz 3BwsHPYqYWh47GPhEoObguWGge7xzgcaHXb6qLXAI1pVvPk51Z5kC7873UmFKndciJMz0+Hv4D5 n0A6ULg2wHiGbdy6ad2OuJAeEFZVPslC2PWxPTC9S6o3mo5o4Yyr/koblm+iPpSl0uTopg4L6Ov CknrncBex/KyHdo7JE6Mybb34tJDxOLaMevJpNOAtskkPKw/uixLZTzzJWDNSRY1gbmSfCqBc1J gHg/4ENcvMBHIj0nBOw== X-Proofpoint-ORIG-GUID: 3A9wZigcNSIK9FhRhEVx3QvAVHf7lLYI X-Proofpoint-GUID: 3A9wZigcNSIK9FhRhEVx3QvAVHf7lLYI 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 bulkscore=0 lowpriorityscore=0 malwarescore=0 priorityscore=1501 clxscore=1011 spamscore=0 impostorscore=0 suspectscore=0 adultscore=0 phishscore=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.yoctoproject.org/g/docs/message/8656 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: 79717 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 25367D19523 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.33763.1769466497679356923 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=F/JbnXHX; 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 60QLW2Bq4101085 for ; Mon, 26 Jan 2026 22:28:16 GMT Received: from mail-dy1-f200.google.com (mail-dy1-f200.google.com [74.125.82.200]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4bxg93g3w8-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-f200.google.com with SMTP id 5a478bee46e88-2b71d3ac508so4734424eec.0 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.yoctoproject.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=F/JbnXHXHCt4ew2DSxR9JRVEOEHDYHYPCCPC/j4q1TF4OA9eobAYk7HOLE/r49wdFm 0K3wum1uAA1bg2sSZ0Coj43z/vsffZ3SNILynpJ9iLXZB1PlbBnI4jUQgjXVdtzVvCuz S29jJvU46ZqMejuV33XtqQu2LTaFKeoy6SNFsd4X8HzN0YHMpiUzo1N4mqfPDkg136lL PRWJ6J6ezotRRjC6WqlSwsu0iC20Ane8IFU5BdFIrcyR+k5q9lIsNr/ttUwaNmdE2Y/+ wV2SzArlIZCCzK+gPUCCN0VZ6Paldykq64xDVMR1VWKb9ZAJwgPcHvWTZGENrPJR9oYK xKkQ== 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=drdPLNxb+xhZhDunpNnFGQ4E5gPwVV7BBOqn1+P7ywNxZ5uR2/Ab4pu6MFNaKEbOyO SbVvqvAaSC7x1xNuhe0OtTgdG4h9q81fnEWC7kriti8dmS/ZH3gRLE/Pe9RQFxGVvpPi SSh/DBx9+M9hE8yA9K15TPkHa7W5VMEdlx6MkDUbBBSruuZXYgXwdcr3Ocj9CUNUkxvJ l24YDpxMELFU1QS0It89i939FSiHIRs8ehjwqLFHxy0tsrgu9BQobjMKXQZr3voqTyck qilJtvEg6lcAd94OZUGyjEiYi9Mdrm/PYz9iuZ7MrwXM2dGTM/nZox5evMM2s6J0jSek 9NfQ== X-Gm-Message-State: AOJu0YxdV3pyqdWi9IXVb3TQRvhIL8OP6Tyx7vAhsUCQqPI81LCx/4AQ hHbEqa65oqSyOzcnYBc/LuTpie08IK0mnfz0+DH167jm2P7Cgto73mWONLWBMMV7N76XnnAmPsl s8RsfNNVsRmcMh6z3K29VK4m2qPhDRCk2mVvaEEaPeBCg8zmj8U4zcan/Ibbgp6cL X-Gm-Gg: AZuq6aIMujUDugfJB8lWLpfBE+ZxhT0/FhM2QSozJ+YF5yRWuX7+cxeAS9tdpN6gImo bS6jBIrRA+49Dk2gwH+WMismaUW6lyyjkUXv+lOHGIOJ/qhblrUknpkr8+BBbr01wuDcjenvSlt pjV9hurtiIm8Q+O7MAlmZsfQ1rd8s4d2b2gQShdKOviN3YhVHiN4wXk/RjXYbIhg32EOKJEfS+x LRm88UDkFsuOoe2iOU6pur9/mPOw6hhDgqhnmhdi1sCdUL4dkretzrY4ptwUfBFhwBSNfIJhL/D wBg0OscEb6tC//jh2c/iqiulSKJzePVM3yfRdVP/doAjFG08UDxs0qKDx8C3ApsmETZ45eNlUft dlrMXWcMv4AeEPxjp4Lw2P1WLplGHHTdaOQv9ucO003ZT4ZdEo6pLqWYY1AWqxYfHhDAJ1AnWX2 GpXA== X-Received: by 2002:a05:7300:7fa7:b0:2ae:5f28:eafc with SMTP id 5a478bee46e88-2b76451ac6bmr3218204eec.27.1769466495751; 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: AW1haW4tMjYwMTI2MDE5MiBTYWx0ZWRfX7XY2rgViLxDq zVidvMoK90DbqicRdGyHOCVs1t7FtwGavAL4Zh+9R/ahD/4VxwhVflkKFq5abH943bObf+3xNmP s5aujg9UUD1ATXUP/8b2EuX/zIRUhpQ19DAG04XXb3gAUmkfGrE4aN0YATiXNf1JGETMt4QFaVR Poi6lb0c68RITcwg42Rb7RpVFr6N+Wmg9E8wh1gx+3U9lnAjCmSrrYXW0RIBzqmQDT/7VuCQGWr FhhvJGvWR4NWISK4Yj5VQvvdsMK9egjHXeZ7Eui4SP3Ab9aMVdFdr282NRzwrrALN6ToP4BudDZ tR5QN9ujIAsoNMNn42qIWZ7XQYZOwVrKAR9pjXUefrxalTIh2r+9J4cPINLehbEMSfbSG2aubM7 Z7IAL7fi8stDI4Khajky1ofVTYN+0kfwMoyJwBPzpHXMqjTsqWcqIpAz2U4rJjeiIW1oikTiU+4 14WZYKBY16+bcUYzRAQ== X-Authority-Analysis: v=2.4 cv=Uc1ciaSN c=1 sm=1 tr=0 ts=6977ea80 cx=c_pps a=PfFC4Oe2JQzmKTvty2cRDw==:117 a=PIITv4rVe324bgT4salBLw==:17 a=vUbySO9Y5rIA:10 a=9UA2AVYIz8kA:10 a=VkNPw1HP01LnGYTKEx00:22 a=CihtY_vhn8dth2W4YvEA:9 a=6Ab_bkdmUrQuMsNx7PHu:22 X-Proofpoint-ORIG-GUID: FWnay23XEIhxM3PsGfTSr5IK0oH51Gm0 X-Proofpoint-GUID: FWnay23XEIhxM3PsGfTSr5IK0oH51Gm0 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=1011 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.yoctoproject.org/g/docs/message/8657 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: