Re: [docs] [bitbake-devel] [PATCH v3] bitbake: doc: Add section for variable context

[Michael Opdenacker <michael.opdenacker@bootlin.com>]

Hi Richard

On 2/27/24 at 17:38, Quentin Schulz via lists.openembedded.org wrote:
> Hi all,
>
> On 2/26/24 15:16, Michael Opdenacker via lists.yoctoproject.org wrote:
>> Hi Simone,
>>
>> On 2/23/24 at 20:20, Simone Weiß wrote:
>>> From: Simone Weiß <simone.p.weiss@posteo.com>
>>>
>>> This is inspired by the same section in the yocto-docs. It aims to 
>>> provide
>>> information in what contexts(recipes, .conf, bbclass,...) a variable 
>>> is usually
>>> used. For that I tried to group similar variables, so that a short 
>>> overview is
>>> given. This was inspired by [YOCTO #14072], but of course does not 
>>> implement a
>>> warning if a variable is used in an unintended context.
>>>
>>> Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
>>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>> ---
>>>
>>> Notes to v3:
>>> - Applied the fixes suggested in review (thanks for the patch! I 
>>> hope adding the
>>>    Signed-off like this during squashing is fine)
>>> - For the ref label, I plan to come up with an svg that illustrates 
>>> tasks,
>>>    recipes, classes, conf (thanks Quentin for the suggestion), but 
>>> in a generic
>>>    way and add it to the Concepts section, I want to add a ref from 
>>> there.
>>>   ...bake-user-manual-ref-variables-context.rst | 91 
>>> +++++++++++++++++++
>>>   doc/index.rst                                 |  1 +
>>>   2 files changed, 92 insertions(+)
>>>   create mode 100644 
>>> doc/bitbake-user-manual/bitbake-user-manual-ref-variables-context.rst
>>
>>
>> Thanks for this new update of this worthy addition to the BitBake 
>> documentation! Everything looks good now.
>> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>
> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> A section on task context would be nice but it can come up in a later 
> patch I guess.
>
> Thanks!
>
> By the way, I had an old doc build lying around and just git pull my 
> local branch + applying this patch and somehow the navbar was not 
> updated to contain this new section, I had to remove the build dir and 
> compile it from scratch. I'm wondering if we aren't missing something 
> somewhere so that this navbar is updated whenever it needs to?
>
> Cheers,
> Quentin


Ping for this nice patch from Simone.
Both of us have given it our "Reviewed-by".

Thanks in advance
Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com