From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <richard.purdie@linuxfoundation.org>
Received: from dan.rpsys.net (dan.rpsys.net [93.97.175.187])
	by yocto-www.yoctoproject.org (Postfix) with ESMTP id 1457DE00406
	for <webhob@yoctoproject.org>; Thu, 22 Aug 2013 10:12:19 -0700 (PDT)
Received: from localhost (dan.rpsys.net [127.0.0.1])
	by dan.rpsys.net (8.14.4/8.14.4/Debian-2.1ubuntu1) with ESMTP id
	r7MHNsXi015102; Thu, 22 Aug 2013 18:23:55 +0100
X-Virus-Scanned: Debian amavisd-new at dan.rpsys.net
Received: from dan.rpsys.net ([127.0.0.1])
	by localhost (dan.rpsys.net [127.0.0.1]) (amavisd-new, port 10024)
	with LMTP id l4BgCGOoyDSO; Thu, 22 Aug 2013 18:23:54 +0100 (BST)
Received: from [192.168.3.10] (rpvlan0 [192.168.3.10]) (authenticated bits=0)
	by dan.rpsys.net (8.14.4/8.14.4/Debian-2.1ubuntu1) with ESMTP id
	r7MHNonc015098
	(version=TLSv1/SSLv3 cipher=DHE-RSA-CAMELLIA256-SHA bits=256
	verify=NOT); Thu, 22 Aug 2013 18:23:52 +0100
Message-ID: <1377191508.6762.28.camel@ted>
From: Richard Purdie <richard.purdie@linuxfoundation.org>
To: "Barros Pena, Belen" <belen.barros.pena@intel.com>
Date: Thu, 22 Aug 2013 18:11:48 +0100
In-Reply-To: <CE3BE9A7.30B64%belen.barros.pena@intel.com>
References: <CE3BE9A7.30B64%belen.barros.pena@intel.com>
X-Mailer: Evolution 3.6.4-0ubuntu1 
Mime-Version: 1.0
Cc: Paul Eggleton <paul.eggleton@linux.intel.com>,
	"webhob@yoctoproject.org" <webhob@yoctoproject.org>
Subject: Re: [Webhob] updating documentation.conf
X-BeenThere: webhob@yoctoproject.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: <webhob.yoctoproject.org>
List-Unsubscribe: <https://lists.yoctoproject.org/options/webhob>,
	<mailto:webhob-request@yoctoproject.org?subject=unsubscribe>
List-Archive: <http://lists.yoctoproject.org/pipermail/webhob>
List-Post: <mailto:webhob@yoctoproject.org>
List-Help: <mailto:webhob-request@yoctoproject.org?subject=help>
List-Subscribe: <https://lists.yoctoproject.org/listinfo/webhob>,
	<mailto:webhob-request@yoctoproject.org?subject=subscribe>
X-List-Received-Date: Thu, 22 Aug 2013 17:12:22 -0000
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit

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