From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH 08/10] ref-manual: put the ARCHIVER_MODE comments on their own lines
Date: Mon, 21 Sep 2026 22:03:37 -0400 [thread overview]
Message-ID: <20260922020339.481929-9-twoerner@gmail.com> (raw)
In-Reply-To: <20260922020339.481929-1-twoerner@gmail.com>
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)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
documentation/ref-manual/variables.rst | 24 ++++++++++++++++--------
1 file changed, 16 insertions(+), 8 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c3722c9e9896..66439ff26e6d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -158,14 +158,22 @@ 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.
- ARCHIVER_MODE[srpm] = "1" # Uses RPM package 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"
+ # Uses RPM package files.
+ ARCHIVER_MODE[srpm] = "1"
For information on how the variable works, see the
``meta/classes/archiver.bbclass`` file in :term:`OpenEmbedded-Core
--
2.50.0.173.g8b6f19ccfc3a
next prev parent reply other threads:[~2026-09-22 2:04 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-22 2:03 [PATCH 00/10] docs: editorial repairs to the examples Trevor Woerner
2026-09-22 2:03 ` [PATCH 01/10] docs: give the root prompts a preamble Trevor Woerner
2026-09-22 2:03 ` [PATCH 02/10] docs: copy only the command from a console block Trevor Woerner
2026-09-22 12:20 ` [docs] " Antonin Godard
2026-09-22 14:40 ` Trevor Woerner
2026-09-22 15:16 ` Antonin Godard
2026-09-22 2:03 ` [PATCH 03/10] docs: show a prompt on commands the reader is meant to type Trevor Woerner
2026-09-22 12:19 ` [docs] " Antonin Godard
2026-09-22 14:23 ` Trevor Woerner
2026-09-22 2:03 ` [PATCH 04/10] docs: write an elided passage as a comment Trevor Woerner
2026-09-22 2:03 ` [PATCH 05/10] docs: mark the placeholders in examples Trevor Woerner
2026-09-22 2:03 ` [PATCH 06/10] docs: remove real accounts from the examples Trevor Woerner
2026-09-22 2:03 ` [PATCH 07/10] kernel-dev: give each example block one thing to hold Trevor Woerner
2026-09-22 12:19 ` [docs] " Antonin Godard
2026-09-22 2:03 ` Trevor Woerner [this message]
2026-09-22 2:03 ` [PATCH 09/10] ref-manual: drop "partition" as a wic kickstart command Trevor Woerner
2026-09-22 12:19 ` [docs] " Antonin Godard
2026-09-22 2:03 ` [PATCH 10/10] dev-manual: indent a list continuation so the code block ends Trevor Woerner
2026-09-22 12:19 ` [docs] " Antonin Godard
2026-09-22 12:19 ` [docs] [PATCH 00/10] docs: editorial repairs to the examples Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260922020339.481929-9-twoerner@gmail.com \
--to=twoerner@gmail.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox