diff mbox series

[18/19] docs-wide: fix space around equal assignments

Message ID 20250729-release-note-5-3-first-bunch-v1-18-058971e37c93@bootlin.com
State New
Headers show
Series Updates from Poky master | expand

Commit Message

Antonin Godard July 29, 2025, 9:56 a.m. UTC
Since commit 24772dd2ae6c ("parse/ConfHandler: Add warning for
deprecated whitespace usage") in BitBake, a warning is printed when
there are no spaces around an `=` assignment.

Adjust the documentation to show good examples only.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/building.rst   | 8 ++++----
 documentation/dev-manual/layers.rst     | 2 +-
 documentation/dev-manual/new-recipe.rst | 2 +-
 documentation/dev-manual/qemu.rst       | 4 ++--
 documentation/ref-manual/variables.rst  | 6 +++---
 5 files changed, 11 insertions(+), 11 deletions(-)
diff mbox series

Patch

diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index 32c7aa5da..04c150094 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -243,9 +243,9 @@  Bundling an Initramfs Image From a Separate Multiconfig
 
 There may be a case where we want to build an :term:`Initramfs` image which does not
 inherit the same distro policy as our main image, for example, we may want
-our main image to use ``TCLIBC="glibc"``, but to use ``TCLIBC="musl"`` in our :term:`Initramfs`
+our main image to use ``TCLIBC = "glibc"``, but to use ``TCLIBC = "musl"`` in our :term:`Initramfs`
 image to keep a smaller footprint. However, by performing the steps mentioned
-above the :term:`Initramfs` image will inherit ``TCLIBC="glibc"`` without allowing us
+above the :term:`Initramfs` image will inherit ``TCLIBC = "glibc"`` without allowing us
 to override it.
 
 To achieve this, you need to perform some additional steps:
@@ -255,8 +255,8 @@  To achieve this, you need to perform some additional steps:
    For the sake of simplicity let's assume such multiconfig is called: ``initramfscfg.conf`` and
    contains the variables::
 
-      TMPDIR="${TOPDIR}/tmp-initramfscfg"
-      TCLIBC="musl"
+      TMPDIR = "${TOPDIR}/tmp-initramfscfg"
+      TCLIBC = "musl"
 
 #. *Set additional Initramfs variables on your main configuration:*
    Additionally, on your main configuration (``local.conf``) you need to set the
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 67482bf54..fbf3f1a33 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -609,7 +609,7 @@  file is in the layer at ``recipes-graphics/xorg-xserver``::
        file://xorg.conf.d/99-calibration.conf \
    "
    do_install:append:rpi () {
-       PITFT="${@bb.utils.contains("MACHINE_FEATURES", "pitft", "1", "0", d)}"
+       PITFT = "${@bb.utils.contains("MACHINE_FEATURES", "pitft", "1", "0", d)}"
        if [ "${PITFT}" = "1" ]; then
            install -d ${D}/${sysconfdir}/X11/xorg.conf.d/
            install -m 0644 ${UNPACKDIR}/xorg.conf.d/98-pitft.conf ${D}/${sysconfdir}/X11/xorg.conf.d/
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index 832aa300e..aa4fb97a4 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -298,7 +298,7 @@  a ``+`` sign in its definition. Here is an example from the recipe
    SRC_URI = "git://github.com/stevenhoneyman/l3afpad.git;branch=master;protocol=https"
 
    PV = "0.8.18.1.11+git"
-   SRCREV ="3cdccdc9505643e50f8208171d9eee5de11a42ff"
+   SRCREV = "3cdccdc9505643e50f8208171d9eee5de11a42ff"
 
 If your :term:`SRC_URI` statement includes URLs pointing to individual files
 fetched from a remote server other than a version control system,
diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst
index 92c93a82a..9e0b8b813 100644
--- a/documentation/dev-manual/qemu.rst
+++ b/documentation/dev-manual/qemu.rst
@@ -424,9 +424,9 @@  command line:
    in the :term:`Build Directory` ``deploy/image`` directory.
    Examples::
 
-      QB_SLIRP_OPT="-netdev user,id=net0,hostfwd=tcp::8080-:80"
+      QB_SLIRP_OPT = "-netdev user,id=net0,hostfwd=tcp::8080-:80"
 
-      QB_SLIRP_OPT="-netdev user,id=net0,hostfwd=tcp::8080-:80,hostfwd=tcp::2222-:22"
+      QB_SLIRP_OPT = "-netdev user,id=net0,hostfwd=tcp::8080-:80,hostfwd=tcp::2222-:22"
 
    The first example forwards TCP port 80 from the emulated system to
    port 8080 (or the next free port) on the host system,
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index cefbfd096..e4d5a9c97 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3360,7 +3360,7 @@  system and gives an overview of their function and contents.
       Here is an example setting "0x400000000" as a load address::
 
          FIT_ADDRESS_CELLS = "2"
-         UBOOT_LOADADDRESS= "0x04 0x00000000"
+         UBOOT_LOADADDRESS = "0x04 0x00000000"
 
       See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__.
 
@@ -4101,7 +4101,7 @@  system and gives an overview of their function and contents.
       The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class defines the manifest
       file as follows::
 
-         IMAGE_MANIFEST ="${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.manifest"
+         IMAGE_MANIFEST = "${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.manifest"
 
       The location is
       derived using the :term:`IMGDEPLOYDIR`
@@ -10496,7 +10496,7 @@  system and gives an overview of their function and contents.
       Here is an example setting "0x400000000" as a load address::
 
          UBOOT_FIT_ADDRESS_CELLS = "2"
-         UBOOT_LOADADDRESS= "0x04 0x00000000"
+         UBOOT_LOADADDRESS = "0x04 0x00000000"
 
       See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__.