Re: [2.6 patch] Kconfig: rename "---help---" to "help" in Kconfig files (first part)

[Adrian Bunk <bunk@stusta.de>]

On Tue, May 03, 2005 at 11:10:48AM +0200, Roman Zippel wrote:
> Hi,
> 
> On Tue, 3 May 2005, Adrian Bunk wrote:
> 
> > This patch is the majority of a patch by Jesper Juhl.
> > 
> > This patch renames all instances of "---help---" to simply "help" in all 
> > of the Kconfig files.
> > 
> > The main reason for this patch (quoting Jesper) is:
> > 
> > Consistency. out of ~4000 help entries in 134 Kconfig files, 747 of 
> > those entries use "---help---" as the keyword, the rest use just "help". 
> > So the users of "---help---" are clearly a minority and by renaming them 
> > we make things consistent. - I hate inconsistency. :-)
> 
> This has nothing to do with consistency but with readability.
> This was introduced to better separate the help in large menu entries. In 
> order to accept this patch, I would either like hear reasons, why this 
> isn't needed anymore or I'd like to see an alternative, more consistent 
> separator.

The separator used for the help is to indent help texts by two 
additional spaces.

IMHO, Kconfig files are quite readable due to this indentation even 
though only a minority of the entries was using "---help---" even 
before this patch.

> bye, Roman

cu
Adrian

-- 

       "Is there not promise of rain?" Ling Tan asked suddenly out
        of the darkness. There had been need of rain for many days.
       "Only a promise," Lao Er said.
                                       Pearl S. Buck - Dragon Seed