[PATCH 00/10] Assorted fixes and additions

[PATCH 00/10] Assorted fixes and additions

[Antonin Godard]

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (10):
      security-manual/securing-images.rst: remove "your" in "your OE-Core"
      bsp-manual/bsp.rst: fix a "local.conf" -> "layer.conf" typo
      ref-manual/structure.rst: fix a "local.conf" -> "layer.conf" typo
      ref-manual/varlocality.rst: mention built-in fragments for distro/machine
      ref-manual/varlocality.rst: remove BBFILES from local configuration assignments
      ref-manual/features.rst: add tools-profile
      ref-manual/variables.rst: BBMULTICONFIG: fix a typo
      dev-manual/poky-manual-setup.rst: suggest use of fragment instead of assignments
      ref-manual/variables.rst: fix local.conf.extended obsolete path
      ref-manual/variables.rst: mention built-in fragments for MACHINE/DISTRO

 documentation/bsp-manual/bsp.rst                  |  2 +-
 documentation/dev-manual/poky-manual-setup.rst    | 10 +++---
 documentation/ref-manual/features.rst             |  4 +++
 documentation/ref-manual/structure.rst            |  2 +-
 documentation/ref-manual/variables.rst            | 39 +++++++++++++++++------
 documentation/ref-manual/varlocality.rst          |  8 ++---
 documentation/security-manual/securing-images.rst |  2 +-
 7 files changed, 45 insertions(+), 22 deletions(-)
---
base-commit: 091c7f30110c019cbd8bec3cdb14b328e333d49d
change-id: 20260911-assorted-fixes-421159677289

[PATCH 01/10] security-manual/securing-images.rst: remove "your" in "your OE-Core"

[Antonin Godard]

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/security-manual/securing-images.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/security-manual/securing-images.rst b/documentation/security-manual/securing-images.rst
index 13ab63ddd..bcf4237bf 100644
--- a/documentation/security-manual/securing-images.rst
+++ b/documentation/security-manual/securing-images.rst
@@ -72,7 +72,7 @@ Security Flags
 
 The Yocto Project has security flags that you can enable that help make
 your build output more secure. The security flags are in the
-``meta/conf/distro/include/security_flags.inc`` file in your
+``meta/conf/distro/include/security_flags.inc`` file in
 :term:`OpenEmbedded-Core (OE-Core)`.
 
 .. note::

-- 
2.55.0

[PATCH 02/10] bsp-manual/bsp.rst: fix a "local.conf" -> "layer.conf" typo

[Antonin Godard]

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/bsp-manual/bsp.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/bsp-manual/bsp.rst b/documentation/bsp-manual/bsp.rst
index b71786e59..8eb4f470b 100644
--- a/documentation/bsp-manual/bsp.rst
+++ b/documentation/bsp-manual/bsp.rst
@@ -1165,7 +1165,7 @@ Use these steps to create a BSP layer:
    :yocto_git:`Source Repositories <>`. To get examples of what you need
    in your configuration file, locate a layer (e.g. "meta-ti") and
    examine the
-   :yocto_git:`local.conf </meta-ti/tree/meta-ti-bsp/conf/layer.conf>`
+   :yocto_git:`layer.conf </meta-ti/tree/meta-ti-bsp/conf/layer.conf>`
    file.
 
 -  *Create a Machine Configuration File:* Create a

-- 
2.55.0

[PATCH 03/10] ref-manual/structure.rst: fix a "local.conf" -> "layer.conf" typo

[Antonin Godard]

The addpylib directive belongs in layer.conf, not local.conf.

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

diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 2886713d4..ff103a55e 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -891,7 +891,7 @@ and lists of files and directories with known permissions.
 
 This directory contains OpenEmbedded Python library code used during the
 build process. It is enabled via the ``addpylib`` directive in
-``meta/conf/local.conf``. For more information, see
+``meta/conf/layer.conf``. For more information, see
 :ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`.
 
 .. _structure-meta-recipes-bsp:

-- 
2.55.0

[PATCH 04/10] ref-manual/varlocality.rst: mention built-in fragments for distro/machine

[Antonin Godard]

Those two variables can clash with the machine and distro built-in
fragments. Mention it.

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

diff --git a/documentation/ref-manual/varlocality.rst b/documentation/ref-manual/varlocality.rst
index e2c086ffa..706ed40ab 100644
--- a/documentation/ref-manual/varlocality.rst
+++ b/documentation/ref-manual/varlocality.rst
@@ -76,9 +76,11 @@ Local
 This section lists variables whose configuration context is the local
 configuration through the ``local.conf`` file.
 
--  :term:`DISTRO`
+-  :term:`DISTRO` (can also be set by the :ref:`ref-fragments-builtin-core-distro`
+   :term:`built-in fragment`)
 
--  :term:`MACHINE`
+-  :term:`MACHINE` (can also be set by the :ref:`ref-fragments-builtin-core-machine`
+   :term:`built-in fragment`)
 
 -  :term:`DL_DIR`
 

-- 
2.55.0

[PATCH 05/10] ref-manual/varlocality.rst: remove BBFILES from local configuration assignments

[Antonin Godard]

The BBFILES is most likely never set by the local.conf file, but the
layer.conf file.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/varlocality.rst | 2 --
 1 file changed, 2 deletions(-)

diff --git a/documentation/ref-manual/varlocality.rst b/documentation/ref-manual/varlocality.rst
index 706ed40ab..29ab6081c 100644
--- a/documentation/ref-manual/varlocality.rst
+++ b/documentation/ref-manual/varlocality.rst
@@ -84,8 +84,6 @@ configuration through the ``local.conf`` file.
 
 -  :term:`DL_DIR`
 
--  :term:`BBFILES`
-
 -  :term:`EXTRA_IMAGE_FEATURES`
 
 -  :term:`PACKAGE_CLASSES`

-- 
2.55.0

[PATCH 06/10] ref-manual/features.rst: add tools-profile

[Antonin Godard]

The tools-profile feature was introduced in 2007 with eabfa35d7ce4
("Rewrite IMAGE_FEATURES tools options (people may be to update their
local.conf), split into debug and profiling and add more profiling
tools.")  but was not documented. Add the feature to the list.

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

diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index 4ee6e20c8..879d98ca1 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -406,6 +406,10 @@ these valid features is as follows:
    in the Yocto Project Development Tasks Manual. For information on
    tracing and profiling, see the :doc:`/profile-manual/index`.
 
+-  *tools-profile:*: Installs profiling tools such as ``perf``. See the
+   :ref:`profile-manual/intro:Yocto Project Profiling and Tracing Manual` for more
+   information.
+
 -  *tools-sdk:* Installs a full SDK that runs on the device.
 
 -  *tools-testapps:* Installs device testing tools (e.g. touchscreen

-- 
2.55.0

[PATCH 07/10] ref-manual/variables.rst: BBMULTICONFIG: fix a typo

[Antonin Godard]

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 08eba7ec5..972349497 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -943,7 +943,7 @@ system and gives an overview of their function and contents.
       Specifies each additional separate configuration when you are
       building targets with multiple configurations. Use this variable in
       your ``conf/local.conf`` configuration file. Specify a
-      multiconfigname for each configuration file you are using. For
+      multiconfig name for each configuration file you are using. For
       example, the following line specifies three configuration files::
 
          BBMULTICONFIG = "configA configB configC"

-- 
2.55.0

[PATCH 08/10] dev-manual/poky-manual-setup.rst: suggest use of fragment instead of assignments

[Antonin Godard]

The poky-manual-setup document was ported from the previous Quick start
guide we used to maintain. While this document is oriented towards
setting variables from configuration files rather than using fragments
and bitbake-setup, we can still suggest to enable hash equivalence
through our sstate-mirror-cdn fragment. This way, changes to this
fragment don't have to be maintained here explicitly.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/poky-manual-setup.rst | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/documentation/dev-manual/poky-manual-setup.rst b/documentation/dev-manual/poky-manual-setup.rst
index 833e1631e..5e65763d5 100644
--- a/documentation/dev-manual/poky-manual-setup.rst
+++ b/documentation/dev-manual/poky-manual-setup.rst
@@ -118,13 +118,11 @@ an entire Linux distribution, including the toolchain, from source.
        This is relevant only when your network and the server that you use
        can download these artifacts faster than you would be able to build them.
 
-       To use such mirrors, uncomment the below lines in your ``conf/local.conf``
-       file in the :term:`Build Directory`::
+       To use such mirrors, run the following command:
 
-          BB_HASHSERVE_UPSTREAM = "wss://hashserv.yoctoproject.org/ws"
-          SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH"
-          BB_HASHSERVE = "auto"
-          BB_SIGNATURE_HANDLER = "OEEquivHash"
+       .. code-block:: console
+
+         $ bitbake-config-build enable-fragment core/yocto/sstate-mirror-cdn
 
        The hash equivalence server needs the websockets python module version 9.1
        or later. Debian GNU/Linux 12 (Bookworm) and later, Fedora, CentOS Stream

-- 
2.55.0

[PATCH 09/10] ref-manual/variables.rst: fix local.conf.extended obsolete path

[Antonin Godard]

The file is now in OE-Core, not meta-yocto anymore.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 972349497..4a41e3501 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5022,8 +5022,8 @@ system and gives an overview of their function and contents.
          to "core-image-minimal-initramfs".
 
       You can also find more information by referencing the
-      ``conf/templates/default/local.conf.sample.extended``
-      configuration file in :yocto_git:`meta-poky </meta-yocto/tree/meta-poky>`, the :ref:`ref-classes-image`
+      :oecore_path:`meta/conf/templates/default/local.conf.sample.extended`
+      configuration file in :term:`OpenEmbedded-Core (OE-Core)`, the :ref:`ref-classes-image`
       class, and the :ref:`ref-classes-kernel` class to see how to use the
       :term:`INITRAMFS_IMAGE` variable.
 

-- 
2.55.0

[PATCH 10/10] ref-manual/variables.rst: mention built-in fragments for MACHINE/DISTRO

[Antonin Godard]

In the MACHINE and DISTRO variable description, mention that these can
be set either with their built-in fragments, or from the local.conf
file.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 4a41e3501..f76e5ba4d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2441,6 +2441,20 @@ system and gives an overview of their function and contents.
       of the distribution, see the :term:`DISTRO_NAME`
       variable.
 
+      You can define the :term:`DISTRO` in two ways:
+
+      -  with the :ref:`ref-fragments-builtin-core-distro` fragment:
+
+         .. code-block:: console
+
+            $ bitbake-config-build enable-fragment distro/<DISTRO>
+
+         Replace ``<DISTRO>`` with the name of the distro in the above
+         command.
+
+      -  in the :ref:`structure-build-conf-local.conf` file found in the
+         :term:`Build Directory`.
+
       The :term:`DISTRO` variable corresponds to a distribution configuration
       file whose root name is the same as the variable's argument and whose
       filename extension is ``.conf``. For example, the distribution
@@ -6121,13 +6135,20 @@ system and gives an overview of their function and contents.
       in-use.
 
    :term:`MACHINE`
-      Specifies the target device for which the image is built. You define
-      :term:`MACHINE` in the ``local.conf`` file found in the
-      :term:`Build Directory`. By default, :term:`MACHINE` is set to
-      "qemux86", which is an x86-based architecture machine to be emulated
-      using QEMU::
+      Specifies the target device for which the image is built. You can define
+      the :term:`MACHINE` in two ways:
 
-         MACHINE ?= "qemux86"
+      -  with the :ref:`ref-fragments-builtin-core-machine` fragment:
+
+         .. code-block:: console
+
+            $ bitbake-config-build enable-fragment machine/<MACHINE>
+
+         Replace ``<MACHINE>`` with the name of the machine in the above
+         command.
+
+      -  in the :ref:`structure-build-conf-local.conf` file found in the
+         :term:`Build Directory`.
 
       The variable corresponds to a machine configuration file of the same
       name, through which machine-specific configurations are set. Thus,

-- 
2.55.0

Re: [PATCH 00/10] Assorted fixes and additions

[Antonin Godard]

Applied to master, thanks!

[01/10] security-manual/securing-images.rst: remove "your" in "your OE-Core"
        https://git.yoctoproject.org/yocto-docs/commit/?id=0ddb7e1685cd
[02/10] bsp-manual/bsp.rst: fix a "local.conf" -> "layer.conf" typo
        https://git.yoctoproject.org/yocto-docs/commit/?id=fb495dd96da3
[03/10] ref-manual/structure.rst: fix a "local.conf" -> "layer.conf" typo
        https://git.yoctoproject.org/yocto-docs/commit/?id=be0d9bf14ee7
[04/10] ref-manual/varlocality.rst: mention built-in fragments for distro/machine
        https://git.yoctoproject.org/yocto-docs/commit/?id=5f922a065676
[05/10] ref-manual/varlocality.rst: remove BBFILES from local configuration assignments
        https://git.yoctoproject.org/yocto-docs/commit/?id=2f2cb936a285
[06/10] ref-manual/features.rst: add tools-profile
        https://git.yoctoproject.org/yocto-docs/commit/?id=3c55d1af536c
[07/10] ref-manual/variables.rst: BBMULTICONFIG: fix a typo
        https://git.yoctoproject.org/yocto-docs/commit/?id=0e575b2512f2
[08/10] dev-manual/poky-manual-setup.rst: suggest use of fragment instead of assignments
        https://git.yoctoproject.org/yocto-docs/commit/?id=933f29490560
[09/10] ref-manual/variables.rst: fix local.conf.extended obsolete path
        https://git.yoctoproject.org/yocto-docs/commit/?id=7362e05392b8
[10/10] ref-manual/variables.rst: mention built-in fragments for MACHINE/DISTRO
        https://git.yoctoproject.org/yocto-docs/commit/?id=43e39aad99cc