From: Michael Opdenacker <michael.opdenacker@bootlin.com>
To: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH] ref-manual: add references to variables only documented in the BitBake manual
Date: Thu, 1 Dec 2022 19:26:23 +0100 [thread overview]
Message-ID: <ffd76424-02b0-0420-3bd7-8c544aac168c@bootlin.com> (raw)
In-Reply-To: <015a0ce9-3745-1720-2af1-3558dc77a688@theobroma-systems.com>
Hi Quentin,
On 12/1/22 18:11, Quentin Schulz wrote:
> Hi Michael,
>
> On 12/1/22 18:06, Michael Opdenacker via lists.yoctoproject.org wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> This makes the Yocto Project manual variable list and index more useful,
>> not missing any potentially useful variable.
>>
>> The price to pay is that a reference to such variables now has to go
>> through
>> the intermediate reference in the Yocto Project variable list, instead
>> of going straight to the Bitbake manual.
>>
>
> Is there a script/command you used and can share that does this or was
> it done entirely manually?
I used this to find the variables only in BitBake's manual...
In BitBake, find all variables:
grep "^ :term:"
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | sed -n
-e 's/^\(.*\)\(:term:`\)\(.*\)\(`\)/\3/p' > /tmp/bitbake-vars.txt
In Yocto docs, find all variables:
grep "^ :term:" documentation/ref-manual/variables.rst | sed -n -e
's/^\(.*\)\(:term:`\)\(.*\)\(`\)/\3/p' > /tmp/yocto-vars.txt
Then find all the Bitbake variables not in the Yocto Docs:
grep -F -x -v -f /tmp/yocto-vars.txt /tmp/bitbake-vars.txt >
/tmp/bitbake-only.txt
Then, I added the variables to documentation/ref-manual/variables.rst
manually.
>
> In any case,
> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Thanks for the review!
Cheers
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
prev parent reply other threads:[~2022-12-01 18:26 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-01 17:06 [PATCH] ref-manual: add references to variables only documented in the BitBake manual michael.opdenacker
2022-12-01 17:11 ` [docs] " Quentin Schulz
2022-12-01 18:26 ` Michael Opdenacker [this message]
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=ffd76424-02b0-0420-3bd7-8c544aac168c@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@theobroma-systems.com \
/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.