diff mbox series

[2/8] ref-manual/terms.rst: Configuration File: split paragraph in a list

Message ID 20260911-remove-local-conf-refs-v1-2-322e1e9a232d@bootlin.com
State New
Headers show
Series Encourage setting global changes in the proper place | expand

Commit Message

Antonin Godard Sept. 11, 2026, 3:11 p.m. UTC
Use a list to enumerate the different kinds of configuration files there
are, to improve readability.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/terms.rst | 37 ++++++++++++++++++++++++-------------
 1 file changed, 24 insertions(+), 13 deletions(-)
diff mbox series

Patch

diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 22cbc8002..c210da4cb 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -195,19 +195,30 @@  universal, the list includes them just in case:
       build system what to build and what to put into the image to support a
       particular platform.
 
-      Configuration files end with a ``.conf`` filename extension. The
-      :file:`conf/local.conf` configuration file in the :term:`Build Directory`
-      contains user-defined variables that affect every build. The
-      :file:`meta-poky/conf/distro/poky.conf` configuration file defines Yocto
-      "distro" configuration variables used only when building with this
-      policy. Machine configuration files, which are located
-      :ref:`bsp-manual/bsp:BSP Layers>, define variables for specific hardware and are
-      only used when building for that target (e.g. the
-      :file:`machine/beaglebone.conf` configuration file defines variables for
-      the Texas Instruments ARM Cortex-A8 development board).
-      :term:`Configuration Fragments <Configuration Fragment>` such as
-      :ref:`ref-fragments-core-yocto-sstate-mirror-cdn` define snippets of
-      configuration that can be enabled from the command-line.
+      Configuration files end with a ``.conf`` filename extension. There are
+      multiple types of configuration files, such as:
+
+      -  The :file:`conf/local.conf` configuration file in the :term:`Build
+         Directory` contains user-defined variables that affect every build.
+
+      -  The :file:`meta-poky/conf/distro/poky.conf` configuration file defines
+         Yocto "distro" configuration variables used only when building with
+         this policy. See the :ref:`dev-manual/custom-distribution:creating your
+         own distribution` section of the Yocto Project Reference Manual for
+         more information.
+
+      -  Machine configuration files, which are located :ref:`bsp-manual/bsp:BSP
+         Layers`, define variables for specific hardware and are only used when
+         building for that target (e.g. the :file:`machine/beaglebone.conf`
+         configuration file defines variables for the Texas Instruments ARM
+         Cortex-A8 development board).
+
+      -  :term:`Configuration Fragments <Configuration Fragment>` such as
+         :ref:`ref-fragments-core-yocto-sstate-mirror-cdn` define snippets of
+         configuration that can be enabled from the command-line.
+
+      See also the :doc:`/ref-manual/structure` section of the Yocto Project
+      Reference Manual for more example of configuration files.
 
    :term:`Configuration Fragment`
       A :term:`Configuration Fragment` (also called Standard :term:`Configuration