diff mbox series

[17/19] ref-manual/qa-checks.rst: add space around equal warning

Message ID 20250729-release-note-5-3-first-bunch-v1-17-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 
After commit 24772dd2ae6c ("parse/ConfHandler: Add warning for
deprecated whitespace usage") in BitBake, a warning is printed is
there's a missing space around an equal assignment in recipes.

Add a qa-check entry to qa-checks.rst.

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

Patch

diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 91a0f6149..69ecad74b 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -649,6 +649,22 @@  Errors and Warnings
     on the operating system. If you are seeing this message then the specified script
     may need to be patched to have a shorter in order to avoid runtime problems.
 
+.. _qa-check-space-around-equal:
+
+-  ``<filename>:<line number> has a lack of whitespace around the assignment: '<assignment>'``
+
+   This warning indicated that there is missing spaces around an assignment.
+
+   For example, the following assignments would print a warning::
+
+      FOO="bar"
+      FOO= "bar"
+      FOO ="bar"
+
+   These should be replaced by::
+
+      FOO = "bar"
+
 .. _qa-check-src-uri-bad:
 
 - ``<recipename>: SRC_URI uses unstable GitHub archives [src-uri-bad]``