[PATCH 0/7] Sync yocto-docs glossary with meta/conf/documentation.conf

[PATCH 0/7] Sync yocto-docs glossary with meta/conf/documentation.conf

[Antonin Godard]

Document variables that are documented in OE-Core's documentation.conf
but not in yocto-docs.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (7):
      ref-manual/variables.rst: document the CCACHE_NATIVE_RECIPES_ALLOWED variable
      ref-manual/variables.rst: document missing CONFLICT_*_FEATURES variables
      ref-manual/variables.rst: document the LOCALE_PATHS variable
      ref-manual/variables.rst: document the TEST_SERIALCONTROL_CONNECT_TIMEOUT variable
      ref-manual/variables.rst: document the LOCALE_UTF8_IS_DEFAULT variable
      ref-manual/variables.rst: document the TEST_SERIALCONTROL_PS1 variable
      ref-manual/variables.rst: document the IMAGE_*_DEBUGFS variables

 documentation/ref-manual/variables.rst | 83 +++++++++++++++++++++++++++++++++-
 1 file changed, 82 insertions(+), 1 deletion(-)
---
base-commit: 4562ba19f36e54099bcae82cec8a70deb1c23aa7
change-id: 20260629-sync-documentation-conf-11689d3b9555

[PATCH 1/7] ref-manual/variables.rst: document the CCACHE_NATIVE_RECIPES_ALLOWED variable

[Antonin Godard]

Added by commit 87cb2be71e0c ("ccache.bbclass: Add allowed list for
native recipes") in OE-Core.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index b4c6bc957..f8765e084 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1530,6 +1530,11 @@ system and gives an overview of their function and contents.
       :term:`CCACHE_DISABLE` variable can be set to "1" in a recipe to disable
       `Ccache` support. This is useful when the recipe is known to not support it.
 
+   :term:`CCACHE_NATIVE_RECIPES_ALLOWED`
+      The :term:`CCACHE_NATIVE_RECIPES_ALLOWED` variable can be set in a
+      :term:`configuration file` to a list of native recipes that are allowed to
+      be optimized with the :ref:`ref-classes-ccache` class.
+
    :term:`CCACHE_TOP_DIR`
       When inheriting the :ref:`ref-classes-ccache` class, the
       :term:`CCACHE_TOP_DIR` variable can be set to the location of where

-- 
2.54.0

[PATCH 2/7] ref-manual/variables.rst: document missing CONFLICT_*_FEATURES variables

[Antonin Godard]

Those are part of the features_check class.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index f8765e084..55c0801bb 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1810,15 +1810,52 @@ system and gives an overview of their function and contents.
       Where :term:`AUTOTOOLS_SCRIPT_PATH` is the location of the of the
       Autotools build system scripts, which defaults to :term:`S`.
 
+   :term:`CONFLICT_COMBINED_FEATURES`
+      When inheriting the :ref:`ref-classes-features_check`
+      class, this variable identifies combined features (see
+      :term:`COMBINED_FEATURES` for what this means) that would be in conflict
+      should the recipe be built. In other words, if the
+      :term:`CONFLICT_COMBINED_FEATURES` variable lists a feature that also
+      appears in :term:`COMBINED_FEATURES` within the current configuration,
+      then the recipe will be skipped, and if the build system attempts to build
+      the recipe then an error will be triggered.
+
    :term:`CONFLICT_DISTRO_FEATURES`
       When inheriting the :ref:`ref-classes-features_check`
-      class, this variable identifies distribution features that would be
+      class, this variable identifies distro features that would be
       in conflict should the recipe be built. In other words, if the
       :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also
       appears in :term:`DISTRO_FEATURES` within the current configuration, then
       the recipe will be skipped, and if the build system attempts to build
       the recipe then an error will be triggered.
 
+   :term:`CONFLICT_IMAGE_FEATURES`
+      When inheriting the :ref:`ref-classes-features_check`
+      class, this variable identifies image features that would be
+      in conflict should the recipe be built. In other words, if the
+      :term:`CONFLICT_IMAGE_FEATURES` variable lists a feature that also
+      appears in :term:`IMAGE_FEATURES` within the current configuration, then
+      the recipe will be skipped, and if the build system attempts to build
+      the recipe then an error will be triggered.
+
+   :term:`CONFLICT_MACHINE_FEATURES`
+      When inheriting the :ref:`ref-classes-features_check`
+      class, this variable identifies machine features that would be
+      in conflict should the recipe be built. In other words, if the
+      :term:`CONFLICT_MACHINE_FEATURES` variable lists a feature that also
+      appears in :term:`MACHINE_FEATURES` within the current configuration, then
+      the recipe will be skipped, and if the build system attempts to build
+      the recipe then an error will be triggered.
+
+   :term:`CONFLICT_TUNE_FEATURES`
+      When inheriting the :ref:`ref-classes-features_check`
+      class, this variable identifies tune features that would be
+      in conflict should the recipe be built. In other words, if the
+      :term:`CONFLICT_TUNE_FEATURES` variable lists a feature that also
+      appears in :term:`TUNE_FEATURES` within the current configuration, then
+      the recipe will be skipped, and if the build system attempts to build
+      the recipe then an error will be triggered.
+
    :term:`CONVERSION_CMD`
       This variable is used for storing image conversion commands.
       Image conversion can convert an image into different objects like:

-- 
2.54.0

[PATCH 3/7] ref-manual/variables.rst: document the LOCALE_PATHS variable

[Antonin Godard]

Added by commit 0ffc7cf01225 ("lib/oe/package: add LOCALE_PATHS to
add define all locations for locales") in OE-Core.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 55c0801bb..64e329c07 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6077,6 +6077,12 @@ system and gives an overview of their function and contents.
          $ uname -r
          3.7.0-rc8-custom
 
+   :term:`LOCALE_PATHS`
+      The :term:`LOCALE_PATHS` variable holds a whitespace separated list of
+      paths that are scanned to construct ``-locale`` packages during
+      :ref:`overview-manual/concepts:Package Splitting`. The list
+      contains ``${datadir}/locale`` by default.
+
    :term:`LOG_DIR`
       Specifies the directory to which the OpenEmbedded build system writes
       overall log files. The default directory is ``${TMPDIR}/log``.

-- 
2.54.0

[PATCH 4/7] ref-manual/variables.rst: document the TEST_SERIALCONTROL_CONNECT_TIMEOUT variable

[Antonin Godard]

Added by commit d817b27d73d2 ("testexport: support for executing
tests over serial") in OE-Core.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 64e329c07..231f61d37 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -10978,6 +10978,11 @@ system and gives an overview of their function and contents.
 
          TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200"
 
+   :term:`TEST_SERIALCONTROL_CONNECT_TIMEOUT`
+      For automated hardware testing with the :ref:`ref-classes-testexport`
+      class, the :term:`TEST_SERIALCONTROL_CONNECT_TIMEOUT` variable specifies
+      the timeout in seconds for the initial connection to the target.
+
    :term:`TEST_SERIALCONTROL_EXTRA_ARGS`
       For automated hardware testing, specifies additional arguments to
       pass through to the command specified in

-- 
2.54.0

[PATCH 5/7] ref-manual/variables.rst: document the LOCALE_UTF8_IS_DEFAULT variable

[Antonin Godard]

Added by commit fcde0c43f7b5 ("libc-package.bbclass: add
LOCALE_UTF8_IS_DEFAULT") in OE-Core.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 231f61d37..20bcf8d60 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6083,6 +6083,13 @@ system and gives an overview of their function and contents.
       :ref:`overview-manual/concepts:Package Splitting`. The list
       contains ``${datadir}/locale`` by default.
 
+   :term:`LOCALE_UTF8_IS_DEFAULT`
+      If set, locale names are renamed such that those lacking an explicit
+      encoding (e.g. ``en_US``) will always be UTF-8, and non-UTF-8 encodings
+      are renamed to, e.g., ``en_US.ISO-8859-1``. Otherwise, the encoding is
+      specified by `Glibc`'s ``SUPPORTED`` file. This not supported for
+      precompiled locales.
+
    :term:`LOG_DIR`
       Specifies the directory to which the OpenEmbedded build system writes
       overall log files. The default directory is ``${TMPDIR}/log``.

-- 
2.54.0

[PATCH 6/7] ref-manual/variables.rst: document the TEST_SERIALCONTROL_PS1 variable

[Antonin Godard]

Added by commit d817b27d73d2 ("testexport: support for executing
tests over serial") in OE-Core.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 20bcf8d60..d23eabad8 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -10998,6 +10998,12 @@ system and gives an overview of their function and contents.
       wish, for example, to separate the machine-specific and
       non-machine-specific parts of the command.
 
+   :term:`TEST_SERIALCONTROL_PS1`
+      For automated hardware testing with the :ref:`ref-classes-testexport`
+      class, the :term:`TEST_SERIALCONTROL_PS1` variable specifies a regex
+      string representing an empty prompt on the target terminal. For example:
+      ``root@target:.*#``.
+
    :term:`TEST_SERVER_IP`
       The IP address of the build machine (host machine). This IP address
       is usually automatically detected. However, if detection fails, this

-- 
2.54.0

[PATCH 7/7] ref-manual/variables.rst: document the IMAGE_*_DEBUGFS variables

[Antonin Godard]

Added by commit 41316293e442 ("lib/oe/image.py: Add image generation
for companion debug filesystem") in OE-Core.

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

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d23eabad8..abb154f44 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4356,6 +4356,21 @@ system and gives an overview of their function and contents.
             or ``:prepend``. You must use the ``+=`` operator to add one or
             more options to the :term:`IMAGE_FSTYPES` variable.
 
+   :term:`IMAGE_FSTYPES_DEBUGFS`
+      The :term:`IMAGE_FSTYPES_DEBUGFS` holds a list of filesystem image types
+      to generate when the :term:`IMAGE_GEN_DEBUGFS` variable is set to "1". The
+      content of this variable is the same as what is supported by the
+      :term:`IMAGE_FSTYPES` variable.
+
+   :term:`IMAGE_GEN_DEBUGFS`
+      When set to "1" in an :ref:`ref-classes-image` recipe, the
+      :term:`OpenEmbedded Build System` will generate a companion image that
+      contains the debug symbols and source code for the packages installed on
+      the image. The :term:`OpenEmbedded Build System` does this by adding all
+      the available ``-dbg`` and ``-src`` packages available in the package
+      feed, which are automatically generated during
+      :ref:`overview-manual/concepts:Package Splitting`.
+
    :term:`IMAGE_INSTALL`
       Used by recipes to specify the packages to install into an image
       through the :ref:`ref-classes-image` class. Use the

-- 
2.54.0

Re: [docs] [PATCH 5/7] ref-manual/variables.rst: document the LOCALE_UTF8_IS_DEFAULT variable

[Daniel Ammann]

Hello Antonin

See below.

Kind regards, Daniel


On 6/30/26 10:13 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Added by commit fcde0c43f7b5 ("libc-package.bbclass: add
> LOCALE_UTF8_IS_DEFAULT") in OE-Core.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 7 +++++++
>   1 file changed, 7 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 231f61d37..20bcf8d60 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -6083,6 +6083,13 @@ system and gives an overview of their function and contents.
>         :ref:`overview-manual/concepts:Package Splitting`. The list
>         contains ``${datadir}/locale`` by default.
>   
> +   :term:`LOCALE_UTF8_IS_DEFAULT`
> +      If set, locale names are renamed such that those lacking an explicit
> +      encoding (e.g. ``en_US``) will always be UTF-8, and non-UTF-8 encodings
> +      are renamed to, e.g., ``en_US.ISO-8859-1``. Otherwise, the encoding is
> +      specified by `Glibc`'s ``SUPPORTED`` file. This not supported for
                                                         ^ is
> +      precompiled locales.
> +
>      :term:`LOG_DIR`
>         Specifies the directory to which the OpenEmbedded build system writes
>         overall log files. The default directory is ``${TMPDIR}/log``.
> 
> 
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#9986): https://lists.yoctoproject.org/g/docs/message/9986
> Mute This Topic: https://lists.yoctoproject.org/mt/120043675/3616718
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [daniel.ammann@bytesatwork.ch]
> -=-=-=-=-=-=-=-=-=-=-=-
> 

Re: [docs] [PATCH 5/7] ref-manual/variables.rst: document the LOCALE_UTF8_IS_DEFAULT variable

[Antonin Godard]

Hi Daniel,

On Fri Jul 3, 2026 at 9:59 AM CEST, Daniel Ammann wrote:
[...]
>> +   :term:`LOCALE_UTF8_IS_DEFAULT`
>> +      If set, locale names are renamed such that those lacking an explicit
>> +      encoding (e.g. ``en_US``) will always be UTF-8, and non-UTF-8 encodings
>> +      are renamed to, e.g., ``en_US.ISO-8859-1``. Otherwise, the encoding is
>> +      specified by `Glibc`'s ``SUPPORTED`` file. This not supported for
>                                                          ^ is

Nice catch, thank you!

@Paul in CC, can you drop this patch when merging the PRs (on master, wrynose
and scarthgap)? It is independent from the others. That way I'll be able to
re-send it without this typo (or else I'll send another patch, that's ok too).

Thanks!
Antonin

Re: [docs] [PATCH 5/7] ref-manual/variables.rst: document the LOCALE_UTF8_IS_DEFAULT variable

[Paul Barker]

[-- Attachment #1: Type: text/plain, Size: 976 bytes --]

On Fri, 2026-07-03 at 11:57 +0200, Antonin Godard wrote:
> Hi Daniel,
> 
> On Fri Jul 3, 2026 at 9:59 AM CEST, Daniel Ammann wrote:
> [...]
> > > +   :term:`LOCALE_UTF8_IS_DEFAULT`
> > > +      If set, locale names are renamed such that those lacking an explicit
> > > +      encoding (e.g. ``en_US``) will always be UTF-8, and non-UTF-8 encodings
> > > +      are renamed to, e.g., ``en_US.ISO-8859-1``. Otherwise, the encoding is
> > > +      specified by `Glibc`'s ``SUPPORTED`` file. This not supported for
> >                                                          ^ is
> 
> Nice catch, thank you!
> 
> @Paul in CC, can you drop this patch when merging the PRs (on master, wrynose
> and scarthgap)? It is independent from the others. That way I'll be able to
> re-send it without this typo (or else I'll send another patch, that's ok too).

Hi Antonin,

I've merged all three PRs with this patch rebased out.

Best regards,

-- 
Paul Barker


[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 252 bytes --]

Re: [PATCH 0/7] Sync yocto-docs glossary with meta/conf/documentation.conf

[Antonin Godard]

Applied, thanks!

[1/7] ref-manual/variables.rst: document the CCACHE_NATIVE_RECIPES_ALLOWED variable
      commit: 8881547719215a86a4a2e51ae3362462419a335b
[2/7] ref-manual/variables.rst: document missing CONFLICT_*_FEATURES variables
      commit: fb38ef19e67b31f855bddb61ad990020d5cef234
[3/7] ref-manual/variables.rst: document the LOCALE_PATHS variable
      commit: b2267d27de5ac5ac163be4c740d725a181f3f2cf
[4/7] ref-manual/variables.rst: document the TEST_SERIALCONTROL_CONNECT_TIMEOUT variable
      commit: 69a8a4ad429e1280416700ce97039296ee996b43
[5/7] ref-manual/variables.rst: document the LOCALE_UTF8_IS_DEFAULT variable
      (not applied)
[6/7] ref-manual/variables.rst: document the TEST_SERIALCONTROL_PS1 variable
      commit: e3704c41ca4a5726ce714c43ae03f64bdd258334
[7/7] ref-manual/variables.rst: document the IMAGE_*_DEBUGFS variables
      commit: ce2af80cadf76740c5b00f1c228d7b55dcc73d0e