From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH v2 8/8] ref-manual: put the ARCHIVER_MODE comments on their own lines
Date: Tue, 22 Sep 2026 14:32:49 -0400 [thread overview]
Message-ID: <20260922183249.2433345-9-twoerner@gmail.com> (raw)
In-Reply-To: <20260922183249.2433345-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>
---
changes in v2:
- the srpm varflag is no longer in this block, having been removed
upstream in d5216e3fd4be
---
documentation/ref-manual/variables.rst | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 8a9bd9075843..0d7069433bf2 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -158,13 +158,20 @@ 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
--
2.50.0.173.g8b6f19ccfc3a
next prev parent reply other threads:[~2026-09-22 18:33 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-22 18:32 [PATCH v2 0/8] docs: editorial repairs to the examples Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 1/8] docs: give the root prompts a preamble Trevor Woerner
2026-09-23 10:17 ` [docs] " Quentin Schulz
2026-09-24 16:00 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 2/8] docs: copy only the command from a console block Trevor Woerner
2026-09-23 10:41 ` [docs] " Quentin Schulz
2026-09-23 10:43 ` Quentin Schulz
2026-09-22 18:32 ` [PATCH v2 3/8] docs: show a prompt on commands the reader is meant to type Trevor Woerner
2026-09-23 10:49 ` [docs] " Quentin Schulz
2026-09-24 15:59 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 4/8] docs: write an elided passage as a comment Trevor Woerner
2026-09-23 10:50 ` [docs] " Quentin Schulz
2026-09-22 18:32 ` [PATCH v2 5/8] docs: mark the placeholders in examples Trevor Woerner
2026-09-23 10:57 ` [docs] " Quentin Schulz
2026-09-24 15:58 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 6/8] docs: remove real accounts from the examples Trevor Woerner
2026-09-23 11:02 ` [docs] " Quentin Schulz
2026-09-24 15:55 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 7/8] kernel-dev: give each example block one thing to hold Trevor Woerner
2026-09-23 11:05 ` [docs] " Quentin Schulz
2026-09-22 18:32 ` Trevor Woerner [this message]
2026-09-23 11:09 ` [docs] [PATCH v2 8/8] ref-manual: put the ARCHIVER_MODE comments on their own lines Quentin Schulz
2026-09-24 15:55 ` Trevor Woerner
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=20260922183249.2433345-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.