From mboxrd@z Thu Jan  1 00:00:00 1970
From: Graeme Russ <graeme.russ@gmail.com>
Date: Thu, 14 Apr 2011 18:36:04 +1000
Subject: [U-Boot] [RFC] Centralise documentation of CONFIG_ options (and
 finding unused ones)
In-Reply-To: <4DA69194.3010801@aribaud.net>
References: <4DA2FDFB.1000901@gmail.com> <4DA69194.3010801@aribaud.net>
Message-ID: <4DA6B1F4.90707@gmail.com>
List-Id: <u-boot.lists.denx.de>
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
To: u-boot@lists.denx.de

On 14/04/11 16:17, Albert ARIBAUD wrote:
> Hi Graeme,
> 
> Le 11/04/2011 15:11, Graeme Russ a ?crit :
> 
>> So my RFC is twofold:
>>   1) Should we start to systematically remove unused options
> 
> I would tend to answer 'yes'. Unused options should not clobber code or 
> documentation.
> 
>>   2) Should we centralise all options in a single README (or two, one for
>> standard CONFIG options and one for CONFIG_SYS options)?
> 
> That would be nice indeed, but it requires all options to have the same 
> semantics over all arches. While this is highly desirable, it may not be 
> true ATM -- just thinking out loud, haven't checked. But even if some 
> options only make sense only for some arch(es), then we could always do 
> it this way:
> 
> 	doc/README.CONFIG_options
> 	doc/README.CONFIG_SYS_options
> 	doc/arch/README.CONFIG_options

Hmm, I have a better idea after I can to the realisation that the central
location for configuration options is Ctrl^F in the doc/ directory :)

	doc/README.CONFIG_options.unused
	doc/README.CONFIG_options.undocumented

I will tweak my scripts to produce these two files and see what the result is.

Regards,

Graeme