Re: [Webhob] updating documentation.conf

[Richard Purdie <richard.purdie@linuxfoundation.org>]

On Thu, 2013-08-22 at 15:40 +0000, Barros Pena, Belen wrote:
> 
> On 22/08/2013 16:02, "Damian, Alexandru" <alexandru.damian@intel.com>
> wrote:
> 
> >not sure how this should be handled, Paul thinks it should be in there ?
> >
> >
> >AFAIK, suffixed variables get used instead of the normal ones, so they
> >are more like replacements.
> >
> >I guess the design ask that we should the only the variables with doc
> >attached,
> 
> Well Š no :) 
> 
> The design actually asked nothing, since it is still very much in the
> works. My request to the team was in the lines of: can we provide a short
> explanation of the variables we show? When trying to work out how to
> actually do this, we were suggested to use documentation.conf to provide
> such explanations. This is quite different from saying "show variables
> with the [doc] flag".

PREFERRED_PROVIDER is perhaps a special case since it will usually have
a suffix and we're not going to add a [doc] tag for every single one.
Special casing that one in the code may make sense.

Are there any other suffixed variables that are causing similar
problems?

I suspect Paul's proposal of knocking off the lowercase suffixes and
seeing if a [doc] tag exists might be the best/only way to attempt to
handle this.

Cheers,

Richard