diff mbox series

[v3,08/10] ref-manual: put the ARCHIVER_MODE comments on their own lines

Message ID 20260924172853.2665062-9-twoerner@gmail.com
State New
Headers show
Series docs: editorial repairs to the examples | expand

Commit Message

Trevor Woerner Sept. 24, 2026, 5:28 p.m. UTC 
BitBake has no inline comments. A "#" after a value is not stripped and
does not end the statement: the parser simply fails to match the line, so
each of these varflag examples would be rejected outright if copied into
a configuration file.

Move each explanation to the line above the setting it describes, which
parses and reads the same.

AI-Generated: codex/claude-opus 5 (xhigh)
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
changes in v3:
- a blank line separates each comment from the setting above it

changes in v2:
- the srpm varflag is no longer in this block, having been removed
  upstream in d5216e3fd4be
---
 documentation/ref-manual/variables.rst | 27 +++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index ce17d713f399..8f6f4e5998d5 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -158,13 +158,26 @@  system and gives an overview of their function and contents.
       original source, configured source, and so forth by employing the
       following variable flags (varflags)::
 
-         ARCHIVER_MODE[src] = "original"                   # Uses original (unpacked) source files.
-         ARCHIVER_MODE[src] = "patched"                    # Uses patched source files. This is the default.
-         ARCHIVER_MODE[src] = "configured"                 # Uses configured source files.
-         ARCHIVER_MODE[diff] = "1"                         # Uses patches between do_unpack and do_patch.
-         ARCHIVER_MODE[diff-exclude] ?= "<file> <file> ..."    # Lists files and directories to exclude from diff.
-         ARCHIVER_MODE[dumpdata] = "1"                     # Uses environment data.
-         ARCHIVER_MODE[recipe] = "1"                       # Uses recipe and include files.
+         # Uses original (unpacked) source files.
+         ARCHIVER_MODE[src] = "original"
+
+         # Uses patched source files. This is the default.
+         ARCHIVER_MODE[src] = "patched"
+
+         # Uses configured source files.
+         ARCHIVER_MODE[src] = "configured"
+
+         # Uses patches between do_unpack and do_patch.
+         ARCHIVER_MODE[diff] = "1"
+
+         # Lists files and directories to exclude from diff.
+         ARCHIVER_MODE[diff-exclude] ?= "<file> <file> ..."
+
+         # Uses environment data.
+         ARCHIVER_MODE[dumpdata] = "1"
+
+         # Uses recipe and include files.
+         ARCHIVER_MODE[recipe] = "1"
 
       For information on how the variable works, see the
       ``meta/classes/archiver.bbclass`` file in :term:`OpenEmbedded-Core