| Message ID | 20260922183249.2433345-9-twoerner@gmail.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | docs: editorial repairs to the examples | expand |
Hi Trevor, On 9/22/26 8:32 PM, Trevor Woerner via lists.yoctoproject.org wrote: > 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" > It probably is also for the best to avoid long lines wherever we can. I personally would add a newline before each new comment so it is easier on the eye but that's just a matter of taste. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Thanks! Quentin
On Wed 2026-09-23 @ 01:09:11 PM, Quentin Schulz wrote: > Hi Trevor, > > On 9/22/26 8:32 PM, Trevor Woerner via lists.yoctoproject.org wrote: > > 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" > > It probably is also for the best to avoid long lines wherever we can. I > personally would add a newline before each new comment so it is easier on > the eye but that's just a matter of taste. I agree too. I was on the fence about it, but since you flagged it, i'm happy to make the change. > Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> > > Thanks! > Quentin
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
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(-)