Re: [docs] [PATCH] ref-manual: add references to variables only documented in the BitBake manual

Michael Opdenacker
2022-12-01T18:26:35Z

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