All of lore.kernel.org
 help / color / mirror / Atom feed
From: Graeme Russ <graeme.russ@gmail.com>
To: u-boot@lists.denx.de
Subject: [U-Boot] [RFC] Centralise documentation of CONFIG_ options (and finding unused ones)
Date: Thu, 14 Apr 2011 18:36:04 +1000	[thread overview]
Message-ID: <4DA6B1F4.90707@gmail.com> (raw)
In-Reply-To: <4DA69194.3010801@aribaud.net>

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

  reply	other threads:[~2011-04-14  8:36 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-04-11 13:11 [U-Boot] [RFC] Centralise documentation of CONFIG_ options (and finding unused ones) Graeme Russ
2011-04-14  6:17 ` Albert ARIBAUD
2011-04-14  8:36   ` Graeme Russ [this message]
2011-04-14  9:14 ` Kumar Gala
2011-04-16  7:16   ` Graeme Russ
2011-04-17 13:30     ` Timur Tabi
2011-04-17 19:26       ` Graeme Russ

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4DA6B1F4.90707@gmail.com \
    --to=graeme.russ@gmail.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.