Re: filling in the "missing" entries in the ref manual variable glossary

[Paul Eggleton <paul.eggleton@linux.intel.com>]

Hi Robert,

On Tuesday 05 November 2013 01:34:56 Robert P. J. Day wrote:
> On Mon, 4 Nov 2013, Rifenbark, Scott M wrote:
> > This will be useful for me... thanks Robert.
> 
>   i'm about halfway through the categorized variable glossary:
> 
> http://www.crashcourse.ca/wiki/index.php/OE_variable_glossary
> 
> and a few variables that caught my eye:
> 
>  * BUGTRACKER (not mentioned)
>  * TUNE_ARCH (not mentioned)
>  * TUNE_FEATURES (not mentioned)
>  * CLASSOVERRIDE (not mentioned)
>  * UBOOT_TARGET (mentioned, but replaced by UBOOT_MAKE_TARGET?)
> 
> and a number of UBOOT-related variables aren't mentioned. not clear if
> any of these *should* be added -- there's obviously a limit to how
> many variables you should explain -- but you can decide if any should
> be added to the ref manual.

I think a variable should be documented if anyone will ever need to know what 
it does - and that probably includes almost all variables. I have talked with 
Scott in the past about some kind of labelling system for the variable 
glossary so you can see at a glance where the variable is supposed to be used 
and (hopefully, if we can come up with sane categorisation) when it's 
appropriate to modify.

IMO, all of those you listed should be documented. I've just entered a bug 
about documenting the tune files / variables at least:

https://bugzilla.yoctoproject.org/show_bug.cgi?id=5463

Cheers,
Paul


-- 

Paul Eggleton
Intel Open Source Technology Centre