Re: Variable reference (was: Documentation update about machine conf files)

[Steffen Sledz <sledz@dresearch.de>]

Christian Gagneraud wrote:
> Actually i was thinking as well to have a document presented as a matrix
> that will show quickly when and where this variables are intended to be
> used or not, ie:
> 
> For each variable, there could be a:
> - one line documentation
> - default value
> - Used by (see below)
> - Used in (see below)
> 
> For "Used by" and "Used in", it could be nice to specify yes, no or
> maybe (with default to no) for the following:
>   - bitbake itself
>   - <file>.bbclass
>   - <package>.bb
>   - <meta>.bb
>   - <image>.bb
>   - bitbake.conf
>   - <distro>.conf
>   - <machine>.conf
>   - local.conf
>   - any other interesting things...
> 
> For the difference between used by and used in, here is an example:
> CMDLINE is used in <machine>.conf or local.conf, and is used by linux.inc
> 
> I'm not (yet) familiar with bitbake and bbclass, but I guess that it is
> possible to extract all these information and generate say an xml file
> that can be in turn transformed into anything people like.
> ...

This sounds really good.

If this can done be automatically may be the best place for it could be a generated appendix to the user manual.

Steffen