Kconfig: rename "---help---" to "help" in Kconfig files (first part)
PATCH 1/1 Kconfig: rename "---help---" to "help" in Kconfig files (first part)
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. :-)
My change to the patch was to drop all parts that don't apply to both 2.6.12-rc3 and 2.6.12-rc3-mm2 (for making inclusion in Linus' tree easier).
My plan for this issue is:
- get this patch accepted
- rename all remaining "---help---" in both -mm and Linus' tree
- remove the "---help---" from the Kconfig language
---
This patch is attached gzip'ed because it's > 200 kB.
arch/alpha/Kconfig | 12 +- arch/arm/Kconfig | 10 +- arch/arm/mach-clps711x/Kconfig | 2 arch/arm/mach-footbridge/Kconfig | 2 arch/arm26/Kconfig | 2 arch/cris/arch-v10/drivers/Kconfig | 4 arch/h8300/Kconfig | 6 - arch/i386/Kconfig | 26 +++--- arch/i386/kernel/cpu/cpufreq/Kconfig | 2 arch/ia64/Kconfig | 2 arch/m32r/Kconfig | 4 arch/m68k/Kconfig | 18 ++-- arch/m68knommu/Kconfig | 8 - arch/mips/Kconfig | 12 +- arch/parisc/Kconfig | 4 arch/ppc/Kconfig | 26 +++--- arch/ppc64/Kconfig | 6 - arch/s390/Kconfig | 4 arch/sh/Kconfig | 8 - arch/sh/cchips/Kconfig | 4 arch/sparc/Kconfig | 14 +-- arch/sparc64/Kconfig | 18 ++-- arch/um/Kconfig | 2 arch/x86_64/Kconfig | 8 - drivers/acpi/Kconfig | 12 +- drivers/atm/Kconfig | 16 +-- drivers/base/Kconfig | 2 drivers/block/Kconfig | 22 ++--- drivers/block/paride/Kconfig | 8 - drivers/cdrom/Kconfig | 20 ++-- drivers/char/Kconfig | 50 +++++------ drivers/char/agp/Kconfig | 6 - drivers/char/ftape/Kconfig | 18 ++-- drivers/char/tpm/Kconfig | 6 - drivers/char/watchdog/Kconfig | 32 +++---- drivers/eisa/Kconfig | 8 - drivers/fc4/Kconfig | 4 drivers/i2c/Kconfig | 2 drivers/ide/Kconfig | 36 ++++---- drivers/infiniband/Kconfig | 2 drivers/infiniband/hw/mthca/Kconfig | 4 drivers/infiniband/ulp/ipoib/Kconfig | 6 - drivers/input/Kconfig | 12 +- drivers/input/gameport/Kconfig | 2 drivers/input/joystick/Kconfig | 6 - drivers/input/mouse/Kconfig | 4 drivers/input/serio/Kconfig | 12 +- drivers/isdn/Kconfig | 4 drivers/isdn/hisax/Kconfig | 2 drivers/macintosh/Kconfig | 2 drivers/md/Kconfig | 28 +++--- drivers/media/Kconfig | 2 drivers/media/dvb/Kconfig | 2 drivers/media/radio/Kconfig | 30 +++---- drivers/media/video/Kconfig | 26 +++--- drivers/message/i2o/Kconfig | 2 drivers/misc/Kconfig | 2 drivers/mtd/Kconfig | 16 +-- drivers/mtd/chips/Kconfig | 2 drivers/mtd/devices/Kconfig | 10 +- drivers/mtd/nand/Kconfig | 2 drivers/net/Kconfig | 114 +++++++++++++-------------- drivers/net/appletalk/Kconfig | 2 drivers/net/arcnet/Kconfig | 8 - drivers/net/hamradio/Kconfig | 16 +-- drivers/net/irda/Kconfig | 8 - drivers/net/pcmcia/Kconfig | 4 drivers/net/tokenring/Kconfig | 12 +- drivers/net/tulip/Kconfig | 14 +-- drivers/net/wan/Kconfig | 26 +++--- drivers/net/wireless/Kconfig | 28 +++--- drivers/parport/Kconfig | 4 drivers/pci/Kconfig | 4 drivers/pci/hotplug/Kconfig | 2 drivers/pcmcia/Kconfig | 8 - drivers/pnp/Kconfig | 2 drivers/pnp/pnpacpi/Kconfig | 2 drivers/pnp/pnpbios/Kconfig | 4 drivers/s390/Kconfig | 2 drivers/scsi/Kconfig | 90 ++++++++++----------- drivers/scsi/qla2xxx/Kconfig | 10 +- drivers/serial/Kconfig | 16 +-- drivers/telephony/Kconfig | 4 drivers/usb/Kconfig | 4 drivers/usb/class/Kconfig | 6 - drivers/usb/core/Kconfig | 2 drivers/usb/host/Kconfig | 14 +-- drivers/usb/image/Kconfig | 2 drivers/usb/input/Kconfig | 16 +-- drivers/usb/media/Kconfig | 22 ++--- drivers/usb/misc/Kconfig | 4 drivers/usb/misc/sisusbvga/Kconfig | 2 drivers/usb/net/Kconfig | 10 +- drivers/usb/serial/Kconfig | 20 ++-- drivers/usb/storage/Kconfig | 4 drivers/video/Kconfig | 50 +++++------ drivers/video/console/Kconfig | 4 drivers/video/geode/Kconfig | 4 drivers/w1/Kconfig | 2 drivers/zorro/Kconfig | 2 fs/Kconfig | 4 fs/ncpfs/Kconfig | 2 fs/nls/Kconfig | 10 +- fs/partitions/Kconfig | 6 - init/Kconfig | 12 +- kernel/power/Kconfig | 6 - net/Kconfig | 8 - net/ax25/Kconfig | 6 - net/decnet/Kconfig | 2 net/ipv4/Kconfig | 24 ++--- net/ipv4/ipvs/Kconfig | 36 ++++---- net/ipv4/netfilter/Kconfig | 12 +- net/ipv6/Kconfig | 12 +- net/ipv6/netfilter/Kconfig | 2 net/ipx/Kconfig | 2 net/irda/Kconfig | 4 net/sched/Kconfig | 48 +++++------ net/sctp/Kconfig | 2 net/xfrm/Kconfig | 2 sound/oss/Kconfig | 16 +-- 120 files changed, 694 insertions(+), 694 deletions(-)
Hi,
Quoted 11 lines · Adrian Bunk
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
Kconfigfiles.The main reason for this patch (quoting Jesper) is:
Consistency. out of ~4000 help entries in 134
Kconfigfiles, 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.
bye, Roman
Quoted 16 lines · Roman Zippel
Hi,
Quoted 11 lines · Adrian Bunk
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
Kconfigfiles.The main reason for this patch (quoting Jesper) is:
Consistency. out of ~4000 help entries in 134
Kconfigfiles, 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. :-)
Quoted 5 lines
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.
Quoted 1 line
bye, Roman
cu
Adrian
Signature · 4 lines
"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 SeedHi,
Quoted 2 lines · Adrian Bunk
The separator used for the help is to indent help texts by two additional spaces.
Yes, that's an additional indicator.
Quoted 3 lines
IMHO,
Kconfigfiles are quite readable due to this indentation even though only a minority of the entries was using "---help---" even before this patch.
So why exactly has to be removed? Is it ugly? Does it make Kconfig worse? Sorry, but only because it's not used that often, is not enough of a reason for me to remove it. If it helps only a little bit to spot the help text start easier, it's IMO worth to keep it.
bye, Roman
Quoted 7 lines · Roman Zippel
Hi,
Quoted 2 lines · Adrian Bunk
The separator used for the help is to indent help texts by two additional spaces.
Quoted 7 lines
Yes, that's an additional indicator.
Quoted 3 lines
IMHO,
Kconfigfiles are quite readable due to this indentation even though only a minority of the entries was using "---help---" even before this patch.So why exactly has to be removed? Is it ugly? Does it make
Kconfigworse?
The ugly thing is that there are currently two different ways to express the same thing. It only causes confusion for people who think those different syntaxes had a different meaning.
Quoted 3 lines
Sorry, but only because it's not used that often, is not enough of a reason for me to remove it. If it helps only a little bit to spot the help text start easier, it's IMO worth to keep it.
Do you or does anyone else have a problem with spotting the help text start with "only" two additional spaces indentation?
If it's only for Aunt Tillie it's not required.
Quoted 1 line
bye, Roman
cu
Adrian
Signature · 4 lines
"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 SeedHi,
Quoted 5 lines · Adrian Bunk
Quoted 1 line
So why exactly has to be removed? Is it ugly? Does it make
Kconfigworse?The ugly thing is that there are currently two different ways to express the same thing. It only causes confusion for people who think those different syntaxes had a different meaning.
Languages often have more than one way to express something, this is not different.
Early on there was some confusion about this from people writing new Kconfig entries (not just reading existing ones), but this was became a non-issue since it's documented now.
Quoted 6 lines
Quoted 3 lines
Sorry, but only because it's not used that often, is not enough of a reason for me to remove it. If it helps only a little bit to spot the help text start easier, it's IMO worth to keep it.
Do you or does anyone else have a problem with spotting the help text start with "only" two additional spaces indentation?
It is easier to spot! Is it a big help? I don't know, but I don't see any improvement in removing them.
Personally I'd rather leave it to the maintainers of these entries, if they don't like it, they can remove it. If this feature is one day not used anymore, I'll remove it.
Quoted 1 line
If it's only for Aunt Tillie it's not required.
Please stop this. There is no point in arguing whether this is good or bad for Aunt Tillie.
bye, Roman
Quoted 1 line · Roman Zippel
Hi,
Hi Roman,
Quoted 8 lines · Adrian Bunk
Quoted 6 lines
Quoted 2 lines
So why exactly has to be removed? Is it ugly? Does it make
Kconfigworse?The ugly thing is that there are currently two different ways to express the same thing. It only causes confusion for people who think those different syntaxes had a different meaning.
Quoted 6 lines
Languages often have more than one way to express something, this is not different.
Early on there was some confusion about this from people writing newKconfigentries (not just reading existing ones), but this was became a non-issue since it's documented now.
...
Different ways for expressing the same thing is good for writers but bad for readers.
E.g. where to place opening braces in C is a religious issue. For the Linux kernel, CodingStyle sets the rules. And although I'd prefer to set them different, I have to admit that the consistency indide the kernel makes reading easier.
Quoted 1 line
bye, Roman
cu
Adrian
Signature · 4 lines
"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