On Mon, Jan 2, 2023 at 8:24 AM Richard Purdie <
richard.pur...@linuxfoundation.org> wrote:
> On Mon, 2023-01-02 at 17:12 +0100, Michael Opdenacker via
> lists.openembedded.org wrote:
> > Hello,
> >
> > I'm checking for Bitbake variables which should be documented in
> > meta/conf/documentation.conf, but before that, I'd like to check how
> > such information is used.
> >
> > In the "Bitbake variables" section, I can see help information about
> > some variables, as in the attached screenshot.
> >
> > However, if I add a new variable such as "NO_RECOMMENDATIONS", no help
> > information is provided about it, even though it is described in
> > meta/conf/documentation.conf.
> >
> > It also turns out that the help information I get on this section comes
> > from bitbake/lib/toaster/toastergui/templates/projectconf.html instead.
> >
> > So, where are variable descriptions in meta/conf/documentation.conf
> > actually used?
>
> I have a suspicion that the html may be generated by a script from
> documentation.conf but I don't really remember. Adding David Reyna to
> cc in case he knows.
>
>
The variables at the top of that screen capture have hard-coded "help"
(tooltip) text.
I believe this was because some/most of the descriptions are Toaster
specific.
The dynamically generated html for user defined config variables comes from
https://git.yoctoproject.org/poky/tree/bitbake/lib/toaster/toastergui/templates/projectconf.html#n445
Interestingly, build configuration variables do actually parse the
"documentation.conf" (via "bitbake.conf") in
https://git.yoctoproject.org/poky/tree/bitbake/lib/toaster/toastergui/templates/configvars.html#n68
which pulls
data from
https://git.yoctoproject.org/poky/tree/bitbake/lib/toaster/toastergui/views.py#n906
which can be viewed at e.g.
http://localhost:8000/toastergui/build/1/configvars
Unfortunately, such a query is not defined in the projectconf view
https://git.yoctoproject.org/poky/tree/bitbake/lib/toaster/toastergui/views.py#n1795
It appears that the scope of variables was intentionally kept to a smaller
set?
Cheers,
>
> Richard
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#176462):
https://lists.openembedded.org/g/openembedded-core/message/176462
Mute This Topic: https://lists.openembedded.org/mt/96009476/21656
Group Owner: openembedded-core+ow...@lists.openembedded.org
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub
[arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
