2.6.22-git* regression: Kconfig prompts without help text

2.6.22-git* regression: Kconfig prompts without help text

[Stefan Richter]

It is an error to add visible Kconfig options without help text.  Among
them are the new "menuconfig" options.  Jan obviously never uses "make
oldconfig".  Most of these options were added after 2.6.22:

BLK_DEV
HID_SUPPORT
INSTRUMENTATION
MACINTOSH_DRIVERS
MISC_DEVICES
USB_SUPPORT

Here are suggestions for help texts.  Please verify if they are correct
and check whether there are more new (menuconfig) options without help
texts.


BLK_DEV
Say Y here to get to see options for various different block device
drivers.  This option alone does not add code to the kernel.

If you say N, options will be skipped and disabled.  Hence say Y.


HID_SUPPORT
Say Y here to get to see options for various computer--human interface
device drivers.  This option alone does not add code to the kernel.

If you say N, options will be skipped and disabled.  Hence say Y.


INSTRUMENTATION
Say Y here to get to see options related to performance measurement,
debugging, and testing.  This option alone does not add code to the kernel.

If you say N, options will be skipped and disabled.


MACINTOSH_DRIVERS
Say Y here to get to see options for devices used with Macintosh
computers, both PPC and Intel based.  This option alone does not add
code to the kernel.

If you say N, options will be skipped and disabled.


MISC_DEVICES
Say Y here to get to see options for device drivers from various
different categories.  This option alone does not add code to the kernel.

If you say N, options will be skipped and disabled.  Hence say Y.


USB_SUPPORT
This option adds core support for Universal Serial Bus (USB).
You will also need drivers from the following menu to make use of it.


PS:

I believe one possible *bug* of this menuconfig stuff is that if (1.)
user X disables menuconfig A in linux-2.6.x because nothing interesting
for him is in there, (2.) developer Y adds something very interesting in
menu A in linux-2.6.x+1, --> (3.) user X will miss this new option when
he runs "make oldconfig" when switching to linux-2.6.x+1 because
everything between 'if A'...'endif # A' will be invisible and disabled.
-- 
Stefan Richter
-=====-=-=== -=== =----
http://arcgraph.de/sr/

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Jan Engelhardt]

Hi,


On Jul 16 2007 20:49, Stefan Richter wrote:
>
>It is an error to add visible Kconfig options without help text.  Among
>them are the new "menuconfig" options.  Jan obviously never uses "make
>oldconfig".

Untrue. Users of menuconfig/xconfig/gconfig who do not know what an
item is supposed to do would not get any helptext either.
It's just that I did not quite know what helptext to put there
besides some trivial "enable this to see more fluffy options from
this category". Feel free to add Blame-From: <srichter> :)
But see below.

>Most of these options were added after 2.6.22:
>
>BLK_DEV
>HID_SUPPORT
>INSTRUMENTATION
>MACINTOSH_DRIVERS
>MISC_DEVICES
>USB_SUPPORT
>
>Here are suggestions for help texts.  Please verify if they are correct
>and check whether there are more new (menuconfig) options without help
>texts.

Other config options without text include:

CRYPTO_HW       (b511431d85948823ec58639bd3137b910964be34)
AUXDISPLAY      (f5920969fb9e29c9d60568864d0a56fe85e8f4b6)
VIRTUALIZATION  (de062065a5293d8f434acb2d6ba5df87ad76bbd9)
ATM_DRIVERS     (4151ce3159c18a990da7fd6f0fe36c73d1c40f87)
NETDEV_1000     (f30486d57bceec2364aa696403d64429ada61b60)
NETDEV_10000    (f30486d57bceec2364aa696403d64429ada61b60)

Thanks for the starting help texts. I have produced a cumulative patch
with both yours and the extra ones listed above. Can we somehow sneak
this directly in without split-to-maintainers? tis' just some help text.
(Patch below)

>PS:
>
>I believe one possible *bug* of this menuconfig stuff is that if (1.)
>user X disables menuconfig A in linux-2.6.x because nothing interesting
>for him is in there, (2.) developer Y adds something very interesting in
>menu A in linux-2.6.x+1, --> (3.) user X will miss this new option when
>he runs "make oldconfig" when switching to linux-2.6.x+1 because
>everything between 'if A'...'endif # A' will be invisible and disabled.

If I once said "I don't want no USB", I do not want to be prompted in a later
version for USB_COFFEE_PAD. :)


	Jan
===
>> add-help-texts-to-textless-menuconfig-objects.diff <<


Add some help texts to recently-introduced kconfig items

Signed-off-by: Jan Engelhardt <jengelh@gmx.de>

---
 arch/i386/Kconfig          |    5 +++++
 drivers/atm/Kconfig        |    5 +++++
 drivers/auxdisplay/Kconfig |    5 +++++
 drivers/block/Kconfig      |    6 ++++++
 drivers/crypto/Kconfig     |    5 +++++
 drivers/hid/Kconfig        |    5 +++++
 drivers/kvm/Kconfig        |    5 +++++
 drivers/macintosh/Kconfig  |    6 ++++++
 drivers/misc/Kconfig       |    5 +++++
 drivers/net/Kconfig        |   15 +++++++++++++++
 drivers/usb/Kconfig        |    3 +++
 11 files changed, 65 insertions(+)

Index: linux-2.6.23/arch/i386/Kconfig
===================================================================
--- linux-2.6.23.orig/arch/i386/Kconfig
+++ linux-2.6.23/arch/i386/Kconfig
@@ -1216,6 +1216,11 @@ menuconfig INSTRUMENTATION
 	bool "Instrumentation Support"
 	depends on EXPERIMENTAL
 	default y
+	---help---
+	Say Y here to get to see options related to performance measurement,
+	debugging, and testing. This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if INSTRUMENTATION
 
Index: linux-2.6.23/drivers/atm/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/atm/Kconfig
+++ linux-2.6.23/drivers/atm/Kconfig
@@ -6,6 +6,11 @@ menuconfig ATM_DRIVERS
 	bool "ATM drivers"
 	depends on NETDEVICES && ATM
 	default y
+	---help---
+	Say Y here to get to see options for Asynchronous Transfer Mode
+	device drivers. This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if ATM_DRIVERS && NETDEVICES && ATM
 
Index: linux-2.6.23/drivers/auxdisplay/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/auxdisplay/Kconfig
+++ linux-2.6.23/drivers/auxdisplay/Kconfig
@@ -8,6 +8,11 @@
 menuconfig AUXDISPLAY
 	depends on PARPORT
 	bool "Auxiliary Display support"
+	---help---
+	Say Y here to get to see options for auxiliary display drivers.
+	This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if AUXDISPLAY && PARPORT
 
Index: linux-2.6.23/drivers/block/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/block/Kconfig
+++ linux-2.6.23/drivers/block/Kconfig
@@ -6,6 +6,12 @@ menuconfig BLK_DEV
 	bool "Block devices"
 	depends on BLOCK
 	default y
+	---help---
+	Say Y here to get to see options for various different block device
+	drivers. This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled;
+	only do this if you know what you are doing.
 
 if BLK_DEV
 
Index: linux-2.6.23/drivers/crypto/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/crypto/Kconfig
+++ linux-2.6.23/drivers/crypto/Kconfig
@@ -2,6 +2,11 @@
 menuconfig CRYPTO_HW
 	bool "Hardware crypto devices"
 	default y
+	---help---
+	Say Y here to get to see options for hardware crypto devices and
+	processors. This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if CRYPTO_HW
 
Index: linux-2.6.23/drivers/hid/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/hid/Kconfig
+++ linux-2.6.23/drivers/hid/Kconfig
@@ -5,6 +5,11 @@ menuconfig HID_SUPPORT
 	bool "HID Devices"
 	depends on INPUT
 	default y
+	---help---
+	Say Y here to get to see options for various computer-human interface
+	device drivers. This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if HID_SUPPORT
 
Index: linux-2.6.23/drivers/kvm/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/kvm/Kconfig
+++ linux-2.6.23/drivers/kvm/Kconfig
@@ -5,6 +5,11 @@ menuconfig VIRTUALIZATION
 	bool "Virtualization"
 	depends on X86
 	default y
+	---help---
+	Say Y here to get to see options for virtualization guest drivers.
+	This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if VIRTUALIZATION
 
Index: linux-2.6.23/drivers/macintosh/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/macintosh/Kconfig
+++ linux-2.6.23/drivers/macintosh/Kconfig
@@ -3,6 +3,12 @@ menuconfig MACINTOSH_DRIVERS
 	bool "Macintosh device drivers"
 	depends on PPC || MAC || X86
 	default y if (PPC_PMAC || MAC)
+	---help---
+	Say Y here to get to see options for devices used with Macintosh
+	computers, both PPC and Intel based. This option alone does not add
+	any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if MACINTOSH_DRIVERS
 
Index: linux-2.6.23/drivers/misc/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/misc/Kconfig
+++ linux-2.6.23/drivers/misc/Kconfig
@@ -5,6 +5,11 @@
 menuconfig MISC_DEVICES
 	bool "Misc devices"
 	default y
+	---help---
+	Say Y here to get to see options for device drivers from various
+	different categories. This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if MISC_DEVICES
 
Index: linux-2.6.23/drivers/net/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/net/Kconfig
+++ linux-2.6.23/drivers/net/Kconfig
@@ -1923,6 +1923,16 @@ menuconfig NETDEV_1000
 	bool "Ethernet (1000 Mbit)"
 	depends on !UML
 	default y
+	---help---
+	Ethernet (also called IEEE 802.3 or ISO 8802-2) is the most common
+	type of Local Area Network (LAN) in universities and companies.
+
+	Say Y here to get to see options for Gigabit Ethernet drivers.
+	This option alone does not add any kernel code.
+	Note that drivers supporting both 100 and 1000 MBit may be listed
+	under "Ethernet (10 or 100MBit)" instead.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if NETDEV_1000
 
@@ -2294,6 +2304,11 @@ menuconfig NETDEV_10000
 	bool "Ethernet (10000 Mbit)"
 	depends on !UML
 	default y
+	---help---
+	Say Y here to get to see options for 10 Gigabit Ethernet drivers.
+	This option alone does not add any kernel code.
+
+	If you say N, all options in this submenu will be skipped and disabled.
 
 if NETDEV_10000
 
Index: linux-2.6.23/drivers/usb/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/usb/Kconfig
+++ linux-2.6.23/drivers/usb/Kconfig
@@ -6,6 +6,9 @@ menuconfig USB_SUPPORT
 	bool "USB support"
 	depends on HAS_IOMEM
 	default y
+	---help---
+	This option adds core support for Universal Serial Bus (USB).
+	You will also need drivers from the following menu to make use of it.
 
 if USB_SUPPORT
 

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Stefan Richter]

Jan Engelhardt wrote:
> On Jul 16 2007 20:49, Stefan Richter wrote:
>>
>>It is an error to add visible Kconfig options without help text.  Among
>>them are the new "menuconfig" options.  Jan obviously never uses "make
>>oldconfig".
> 
> Untrue. Users of menuconfig/xconfig/gconfig who do not know what an
> item is supposed to do would not get any helptext either.

I mentioned 'make oldconfig' because there you can't get a preview of
what other options you are perhaps about to enable or disable.

> It's just that I did not quite know what helptext to put there
> besides some trivial "enable this to see more fluffy options from
> this category". Feel free to add Blame-From: <srichter> :)

Maybe I'm extraordinarily dumb, but I felt unable to determine for sure
what consequences enabling or disabling some of those new prompts had
when I ran 'make oldconfig' for the first time in a post-2.6.22 tree.

Will saying Y merely present further options, or will it actually cause
something to be built?

> But see below.
> 
>>Most of these options were added after 2.6.22:
>>
>>BLK_DEV
>>HID_SUPPORT
>>INSTRUMENTATION
>>MACINTOSH_DRIVERS
>>MISC_DEVICES
>>USB_SUPPORT
>>
>>Here are suggestions for help texts.  Please verify if they are correct
>>and check whether there are more new (menuconfig) options without help
>>texts.
> 
> Other config options without text include:
> 
> CRYPTO_HW       (b511431d85948823ec58639bd3137b910964be34)
> AUXDISPLAY      (f5920969fb9e29c9d60568864d0a56fe85e8f4b6)
> VIRTUALIZATION  (de062065a5293d8f434acb2d6ba5df87ad76bbd9)
> ATM_DRIVERS     (4151ce3159c18a990da7fd6f0fe36c73d1c40f87)
> NETDEV_1000     (f30486d57bceec2364aa696403d64429ada61b60)
> NETDEV_10000    (f30486d57bceec2364aa696403d64429ada61b60)
> 
> Thanks for the starting help texts. I have produced a cumulative patch
> with both yours and the extra ones listed above.

Thanks for making an actual patch out of it and adding these other bits.

> Can we somehow sneak
> this directly in without split-to-maintainers? tis' just some help text.
> (Patch below)
> 
>>PS:
>>
>>I believe one possible *bug* of this menuconfig stuff is that if (1.)
>>user X disables menuconfig A in linux-2.6.x because nothing interesting
>>for him is in there, (2.) developer Y adds something very interesting in
>>menu A in linux-2.6.x+1, --> (3.) user X will miss this new option when
>>he runs "make oldconfig" when switching to linux-2.6.x+1 because
>>everything between 'if A'...'endif # A' will be invisible and disabled.
> 
> If I once said "I don't want no USB", I do not want to be prompted in a later
> version for USB_COFFEE_PAD. :)

Sure, if I disable USB now I expect that I may possibly miss
USB_COFFEE_PAD in 2.6.47.  That wouldn't worry me.

But what about loosely defined categories like BLK_DEV, INSTRUMENTATION,
MISC_DEVICES?  What functionality will be provided by their suboptions
in 2.6.47?
-- 
Stefan Richter
-=====-=-=== -=== =--=-
http://arcgraph.de/sr/

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Randy Dunlap]

On Wed, 18 Jul 2007 17:18:34 +0200 (CEST) Jan Engelhardt wrote:

> Hi,
> 
> 
> On Jul 16 2007 20:49, Stefan Richter wrote:
> >
> >It is an error to add visible Kconfig options without help text.  Among
> >them are the new "menuconfig" options.  Jan obviously never uses "make
> >oldconfig".
> 
> Untrue. Users of menuconfig/xconfig/gconfig who do not know what an
> item is supposed to do would not get any helptext either.
> It's just that I did not quite know what helptext to put there
> besides some trivial "enable this to see more fluffy options from
> this category". Feel free to add Blame-From: <srichter> :)
> But see below.
> 
> >Most of these options were added after 2.6.22:
> >
> >BLK_DEV
> >HID_SUPPORT
> >INSTRUMENTATION
> >MACINTOSH_DRIVERS
> >MISC_DEVICES
> >USB_SUPPORT
> >
> >Here are suggestions for help texts.  Please verify if they are correct
> >and check whether there are more new (menuconfig) options without help
> >texts.
> 
> Other config options without text include:
> 
> CRYPTO_HW       (b511431d85948823ec58639bd3137b910964be34)
> AUXDISPLAY      (f5920969fb9e29c9d60568864d0a56fe85e8f4b6)
> VIRTUALIZATION  (de062065a5293d8f434acb2d6ba5df87ad76bbd9)
> ATM_DRIVERS     (4151ce3159c18a990da7fd6f0fe36c73d1c40f87)
> NETDEV_1000     (f30486d57bceec2364aa696403d64429ada61b60)
> NETDEV_10000    (f30486d57bceec2364aa696403d64429ada61b60)
> 
> Thanks for the starting help texts. I have produced a cumulative patch
> with both yours and the extra ones listed above. Can we somehow sneak
> this directly in without split-to-maintainers? tis' just some help text.
> (Patch below)
> 
> >PS:
> >
> >I believe one possible *bug* of this menuconfig stuff is that if (1.)
> >user X disables menuconfig A in linux-2.6.x because nothing interesting
> >for him is in there, (2.) developer Y adds something very interesting in
> >menu A in linux-2.6.x+1, --> (3.) user X will miss this new option when
> >he runs "make oldconfig" when switching to linux-2.6.x+1 because
> >everything between 'if A'...'endif # A' will be invisible and disabled.
> 
> If I once said "I don't want no USB", I do not want to be prompted in a later
> version for USB_COFFEE_PAD. :)
> 
> 
> 	Jan
> ===
> >> add-help-texts-to-textless-menuconfig-objects.diff <<

Looks good to me except that help text should be indented by
2 more spaces according to CodingStyle.

> Add some help texts to recently-introduced kconfig items
> 
> Signed-off-by: Jan Engelhardt <jengelh@gmx.de>
> 
> ---
>  arch/i386/Kconfig          |    5 +++++
>  drivers/atm/Kconfig        |    5 +++++
>  drivers/auxdisplay/Kconfig |    5 +++++
>  drivers/block/Kconfig      |    6 ++++++
>  drivers/crypto/Kconfig     |    5 +++++
>  drivers/hid/Kconfig        |    5 +++++
>  drivers/kvm/Kconfig        |    5 +++++
>  drivers/macintosh/Kconfig  |    6 ++++++
>  drivers/misc/Kconfig       |    5 +++++
>  drivers/net/Kconfig        |   15 +++++++++++++++
>  drivers/usb/Kconfig        |    3 +++
>  11 files changed, 65 insertions(+)
> 
> Index: linux-2.6.23/arch/i386/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/arch/i386/Kconfig
> +++ linux-2.6.23/arch/i386/Kconfig
> @@ -1216,6 +1216,11 @@ menuconfig INSTRUMENTATION
>  	bool "Instrumentation Support"
>  	depends on EXPERIMENTAL
>  	default y
> +	---help---
> +	Say Y here to get to see options related to performance measurement,
> +	debugging, and testing. This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if INSTRUMENTATION
>  
> Index: linux-2.6.23/drivers/atm/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/atm/Kconfig
> +++ linux-2.6.23/drivers/atm/Kconfig
> @@ -6,6 +6,11 @@ menuconfig ATM_DRIVERS
>  	bool "ATM drivers"
>  	depends on NETDEVICES && ATM
>  	default y
> +	---help---
> +	Say Y here to get to see options for Asynchronous Transfer Mode
> +	device drivers. This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if ATM_DRIVERS && NETDEVICES && ATM
>  
> Index: linux-2.6.23/drivers/auxdisplay/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/auxdisplay/Kconfig
> +++ linux-2.6.23/drivers/auxdisplay/Kconfig
> @@ -8,6 +8,11 @@
>  menuconfig AUXDISPLAY
>  	depends on PARPORT
>  	bool "Auxiliary Display support"
> +	---help---
> +	Say Y here to get to see options for auxiliary display drivers.
> +	This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if AUXDISPLAY && PARPORT
>  
> Index: linux-2.6.23/drivers/block/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/block/Kconfig
> +++ linux-2.6.23/drivers/block/Kconfig
> @@ -6,6 +6,12 @@ menuconfig BLK_DEV
>  	bool "Block devices"
>  	depends on BLOCK
>  	default y
> +	---help---
> +	Say Y here to get to see options for various different block device
> +	drivers. This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled;
> +	only do this if you know what you are doing.
>  
>  if BLK_DEV
>  
> Index: linux-2.6.23/drivers/crypto/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/crypto/Kconfig
> +++ linux-2.6.23/drivers/crypto/Kconfig
> @@ -2,6 +2,11 @@
>  menuconfig CRYPTO_HW
>  	bool "Hardware crypto devices"
>  	default y
> +	---help---
> +	Say Y here to get to see options for hardware crypto devices and
> +	processors. This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if CRYPTO_HW
>  
> Index: linux-2.6.23/drivers/hid/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/hid/Kconfig
> +++ linux-2.6.23/drivers/hid/Kconfig
> @@ -5,6 +5,11 @@ menuconfig HID_SUPPORT
>  	bool "HID Devices"
>  	depends on INPUT
>  	default y
> +	---help---
> +	Say Y here to get to see options for various computer-human interface
> +	device drivers. This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if HID_SUPPORT
>  
> Index: linux-2.6.23/drivers/kvm/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/kvm/Kconfig
> +++ linux-2.6.23/drivers/kvm/Kconfig
> @@ -5,6 +5,11 @@ menuconfig VIRTUALIZATION
>  	bool "Virtualization"
>  	depends on X86
>  	default y
> +	---help---
> +	Say Y here to get to see options for virtualization guest drivers.
> +	This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if VIRTUALIZATION
>  
> Index: linux-2.6.23/drivers/macintosh/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/macintosh/Kconfig
> +++ linux-2.6.23/drivers/macintosh/Kconfig
> @@ -3,6 +3,12 @@ menuconfig MACINTOSH_DRIVERS
>  	bool "Macintosh device drivers"
>  	depends on PPC || MAC || X86
>  	default y if (PPC_PMAC || MAC)
> +	---help---
> +	Say Y here to get to see options for devices used with Macintosh
> +	computers, both PPC and Intel based. This option alone does not add
> +	any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if MACINTOSH_DRIVERS
>  
> Index: linux-2.6.23/drivers/misc/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/misc/Kconfig
> +++ linux-2.6.23/drivers/misc/Kconfig
> @@ -5,6 +5,11 @@
>  menuconfig MISC_DEVICES
>  	bool "Misc devices"
>  	default y
> +	---help---
> +	Say Y here to get to see options for device drivers from various
> +	different categories. This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if MISC_DEVICES
>  
> Index: linux-2.6.23/drivers/net/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/net/Kconfig
> +++ linux-2.6.23/drivers/net/Kconfig
> @@ -1923,6 +1923,16 @@ menuconfig NETDEV_1000
>  	bool "Ethernet (1000 Mbit)"
>  	depends on !UML
>  	default y
> +	---help---
> +	Ethernet (also called IEEE 802.3 or ISO 8802-2) is the most common
> +	type of Local Area Network (LAN) in universities and companies.
> +
> +	Say Y here to get to see options for Gigabit Ethernet drivers.
> +	This option alone does not add any kernel code.
> +	Note that drivers supporting both 100 and 1000 MBit may be listed
> +	under "Ethernet (10 or 100MBit)" instead.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if NETDEV_1000
>  
> @@ -2294,6 +2304,11 @@ menuconfig NETDEV_10000
>  	bool "Ethernet (10000 Mbit)"
>  	depends on !UML
>  	default y
> +	---help---
> +	Say Y here to get to see options for 10 Gigabit Ethernet drivers.
> +	This option alone does not add any kernel code.
> +
> +	If you say N, all options in this submenu will be skipped and disabled.
>  
>  if NETDEV_10000
>  
> Index: linux-2.6.23/drivers/usb/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/usb/Kconfig
> +++ linux-2.6.23/drivers/usb/Kconfig
> @@ -6,6 +6,9 @@ menuconfig USB_SUPPORT
>  	bool "USB support"
>  	depends on HAS_IOMEM
>  	default y
> +	---help---
> +	This option adds core support for Universal Serial Bus (USB).
> +	You will also need drivers from the following menu to make use of it.
>  
>  if USB_SUPPORT


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Jan Engelhardt]

On Jul 18 2007 09:41, Randy Dunlap wrote:
>
>Looks good to me except that help text should be indented by
>2 more spaces according to CodingStyle.

Who invented that rule anyway... the "---help---" marker (note the dashes)
clearly separates things already.
Here you go.

===

Add some help texts to recently-introduced kconfig items

Signed-off-by: Jan Engelhardt <jengelh@gmx.de>

---
 arch/i386/Kconfig          |    5 +++++
 drivers/atm/Kconfig        |    5 +++++
 drivers/auxdisplay/Kconfig |    5 +++++
 drivers/block/Kconfig      |    6 ++++++
 drivers/crypto/Kconfig     |    5 +++++
 drivers/hid/Kconfig        |    5 +++++
 drivers/kvm/Kconfig        |    5 +++++
 drivers/macintosh/Kconfig  |    6 ++++++
 drivers/misc/Kconfig       |    5 +++++
 drivers/net/Kconfig        |   15 +++++++++++++++
 drivers/usb/Kconfig        |    3 +++
 11 files changed, 65 insertions(+)

Index: linux-2.6.23/arch/i386/Kconfig
===================================================================
--- linux-2.6.23.orig/arch/i386/Kconfig
+++ linux-2.6.23/arch/i386/Kconfig
@@ -1216,6 +1216,11 @@ menuconfig INSTRUMENTATION
 	bool "Instrumentation Support"
 	depends on EXPERIMENTAL
 	default y
+	---help---
+	  Say Y here to get to see options related to performance measurement,
+	  debugging, and testing. This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if INSTRUMENTATION
 
Index: linux-2.6.23/drivers/atm/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/atm/Kconfig
+++ linux-2.6.23/drivers/atm/Kconfig
@@ -6,6 +6,11 @@ menuconfig ATM_DRIVERS
 	bool "ATM drivers"
 	depends on NETDEVICES && ATM
 	default y
+	---help---
+	  Say Y here to get to see options for Asynchronous Transfer Mode
+	  device drivers. This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if ATM_DRIVERS && NETDEVICES && ATM
 
Index: linux-2.6.23/drivers/auxdisplay/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/auxdisplay/Kconfig
+++ linux-2.6.23/drivers/auxdisplay/Kconfig
@@ -8,6 +8,11 @@
 menuconfig AUXDISPLAY
 	depends on PARPORT
 	bool "Auxiliary Display support"
+	---help---
+	  Say Y here to get to see options for auxiliary display drivers.
+	  This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if AUXDISPLAY && PARPORT
 
Index: linux-2.6.23/drivers/block/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/block/Kconfig
+++ linux-2.6.23/drivers/block/Kconfig
@@ -6,6 +6,12 @@ menuconfig BLK_DEV
 	bool "Block devices"
 	depends on BLOCK
 	default y
+	---help---
+	  Say Y here to get to see options for various different block device
+	  drivers. This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled;
+	  only do this if you know what you are doing.
 
 if BLK_DEV
 
Index: linux-2.6.23/drivers/crypto/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/crypto/Kconfig
+++ linux-2.6.23/drivers/crypto/Kconfig
@@ -2,6 +2,11 @@
 menuconfig CRYPTO_HW
 	bool "Hardware crypto devices"
 	default y
+	---help---
+	  Say Y here to get to see options for hardware crypto devices and
+	  processors. This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if CRYPTO_HW
 
Index: linux-2.6.23/drivers/hid/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/hid/Kconfig
+++ linux-2.6.23/drivers/hid/Kconfig
@@ -5,6 +5,11 @@ menuconfig HID_SUPPORT
 	bool "HID Devices"
 	depends on INPUT
 	default y
+	---help---
+	  Say Y here to get to see options for various computer-human interface
+	  device drivers. This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if HID_SUPPORT
 
Index: linux-2.6.23/drivers/kvm/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/kvm/Kconfig
+++ linux-2.6.23/drivers/kvm/Kconfig
@@ -5,6 +5,11 @@ menuconfig VIRTUALIZATION
 	bool "Virtualization"
 	depends on X86
 	default y
+	---help---
+	  Say Y here to get to see options for virtualization guest drivers.
+	  This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if VIRTUALIZATION
 
Index: linux-2.6.23/drivers/macintosh/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/macintosh/Kconfig
+++ linux-2.6.23/drivers/macintosh/Kconfig
@@ -3,6 +3,12 @@ menuconfig MACINTOSH_DRIVERS
 	bool "Macintosh device drivers"
 	depends on PPC || MAC || X86
 	default y if (PPC_PMAC || MAC)
+	---help---
+	  Say Y here to get to see options for devices used with Macintosh
+	  computers, both PPC and Intel based. This option alone does not add
+	  any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if MACINTOSH_DRIVERS
 
Index: linux-2.6.23/drivers/misc/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/misc/Kconfig
+++ linux-2.6.23/drivers/misc/Kconfig
@@ -5,6 +5,11 @@
 menuconfig MISC_DEVICES
 	bool "Misc devices"
 	default y
+	---help---
+	  Say Y here to get to see options for device drivers from various
+	  different categories. This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if MISC_DEVICES
 
Index: linux-2.6.23/drivers/net/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/net/Kconfig
+++ linux-2.6.23/drivers/net/Kconfig
@@ -1923,6 +1923,16 @@ menuconfig NETDEV_1000
 	bool "Ethernet (1000 Mbit)"
 	depends on !UML
 	default y
+	---help---
+	  Ethernet (also called IEEE 802.3 or ISO 8802-2) is the most common
+	  type of Local Area Network (LAN) in universities and companies.
+
+	  Say Y here to get to see options for Gigabit Ethernet drivers.
+	  This option alone does not add any kernel code.
+	  Note that drivers supporting both 100 and 1000 MBit may be listed
+	  under "Ethernet (10 or 100MBit)" instead.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if NETDEV_1000
 
@@ -2294,6 +2304,11 @@ menuconfig NETDEV_10000
 	bool "Ethernet (10000 Mbit)"
 	depends on !UML
 	default y
+	---help---
+	  Say Y here to get to see options for 10 Gigabit Ethernet drivers.
+	  This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
 
 if NETDEV_10000
 
Index: linux-2.6.23/drivers/usb/Kconfig
===================================================================
--- linux-2.6.23.orig/drivers/usb/Kconfig
+++ linux-2.6.23/drivers/usb/Kconfig
@@ -6,6 +6,9 @@ menuconfig USB_SUPPORT
 	bool "USB support"
 	depends on HAS_IOMEM
 	default y
+	---help---
+	  This option adds core support for Universal Serial Bus (USB).
+	  You will also need drivers from the following menu to make use of it.
 
 if USB_SUPPORT
 

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Randy Dunlap]

On Wed, 18 Jul 2007 19:17:49 +0200 (CEST) Jan Engelhardt wrote:

> 
> On Jul 18 2007 09:41, Randy Dunlap wrote:
> >
> >Looks good to me except that help text should be indented by
> >2 more spaces according to CodingStyle.
> 
> Who invented that rule anyway... the "---help---" marker (note the dashes)
> clearly separates things already.
> Here you go.

I have no idea where it came from.  (not me)

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Jan Engelhardt]

On Jul 18 2007 10:34, Randy Dunlap wrote:
>> On Jul 18 2007 09:41, Randy Dunlap wrote:
>> >
>> >Looks good to me except that help text should be indented by
>> >2 more spaces according to CodingStyle.
>> 
>> Who invented that rule anyway... the "---help---" marker (note the dashes)
>> clearly separates things already.
>> Here you go.
>
>I have no idea where it came from.  (not me)

It was akpm:
http://linux.bkbits.net:8080/linux-2.6/Documentation/CodingStyle?PAGE=diffs&REV=1.5

Well, can we lift it?


Thanks,
	Jan
-- 

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Randy Dunlap]

Jan Engelhardt wrote:
> On Jul 18 2007 10:34, Randy Dunlap wrote:
>>> On Jul 18 2007 09:41, Randy Dunlap wrote:
>>>> Looks good to me except that help text should be indented by
>>>> 2 more spaces according to CodingStyle.
>>> Who invented that rule anyway... the "---help---" marker (note the dashes)
>>> clearly separates things already.
>>> Here you go.
>> I have no idea where it came from.  (not me)
> 
> It was akpm:
> http://linux.bkbits.net:8080/linux-2.6/Documentation/CodingStyle?PAGE=diffs&REV=1.5
> 
> Well, can we lift it?

I think that would only make sense if "---help---" is used (like you did)
instead of the plain "help" string.

In the case of "---help---", it's OK with me not to be indented by 2 more
spaces.

-- 
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Jan Engelhardt]

On Jul 18 2007 11:04, Randy Dunlap wrote:
>> > I have no idea where it came from.  (not me)
>> 
>> It was akpm:
>> http://linux.bkbits.net:8080/linux-2.6/Documentation/CodingStyle?PAGE=diffs&REV=1.5
>
> I think that would only make sense if "---help---" is used (like you did)
> instead of the plain "help" string.
>
> In the case of "---help---", it's OK with me not to be indented by 2 more
> spaces.

===

kconf also accepts "---help---" besides the usual "help" keyword.
If it is used, I think we can omit the extra spaces, because the
dashes are visible enough a sash.

Signed-off-by: Jan Engelhardt <jengelh@gmx.de>

---
 Documentation/CodingStyle |   13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

Index: linux-2.6.23/Documentation/CodingStyle
===================================================================
--- linux-2.6.23.orig/Documentation/CodingStyle
+++ linux-2.6.23/Documentation/CodingStyle
@@ -511,17 +511,16 @@ remember: "indent" is not a fix for bad 
 
 For all of the Kconfig* configuration files throughout the source tree,
 the indentation is somewhat different.  Lines under a "config" definition
-are indented with one tab, while help text is indented an additional two
-spaces.  Example:
+are indented with one tab. Example:
 
 config AUDIT
 	bool "Auditing support"
 	depends on NET
-	help
-	  Enable auditing infrastructure that can be used with another
-	  kernel subsystem, such as SELinux (which requires this for
-	  logging of avc messages output).  Does not do system-call
-	  auditing without CONFIG_AUDITSYSCALL.
+	---help---
+	Enable auditing infrastructure that can be used with another
+	kernel subsystem, such as SELinux (which requires this for
+	logging of avc messages output).  Does not do system-call
+	auditing without CONFIG_AUDITSYSCALL.
 
 Features that might still be considered unstable should be defined as
 dependent on "EXPERIMENTAL":

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Adrian Bunk]

On Wed, Jul 18, 2007 at 08:33:27PM +0200, Jan Engelhardt wrote:
> 
> On Jul 18 2007 11:04, Randy Dunlap wrote:
> >> > I have no idea where it came from.  (not me)
> >> 
> >> It was akpm:
> >> http://linux.bkbits.net:8080/linux-2.6/Documentation/CodingStyle?PAGE=diffs&REV=1.5
> >
> > I think that would only make sense if "---help---" is used (like you did)
> > instead of the plain "help" string.
> >
> > In the case of "---help---", it's OK with me not to be indented by 2 more
> > spaces.
> 
> ===
> 
> kconf also accepts "---help---" besides the usual "help" keyword.
> If it is used, I think we can omit the extra spaces, because the
> dashes are visible enough a sash.


Nope, the majority of "---help---" users don't omit the spaces - and it's 
more readable with them.


> Signed-off-by: Jan Engelhardt <jengelh@gmx.de>
> 
> ---
>  Documentation/CodingStyle |   13 ++++++-------
>  1 file changed, 6 insertions(+), 7 deletions(-)
> 
> Index: linux-2.6.23/Documentation/CodingStyle
> ===================================================================
> --- linux-2.6.23.orig/Documentation/CodingStyle
> +++ linux-2.6.23/Documentation/CodingStyle
> @@ -511,17 +511,16 @@ remember: "indent" is not a fix for bad 
>  
>  For all of the Kconfig* configuration files throughout the source tree,
>  the indentation is somewhat different.  Lines under a "config" definition
> -are indented with one tab, while help text is indented an additional two
> -spaces.  Example:
> +are indented with one tab. Example:
>  
>  config AUDIT
>  	bool "Auditing support"
>  	depends on NET
> -	help
> -	  Enable auditing infrastructure that can be used with another
> -	  kernel subsystem, such as SELinux (which requires this for
> -	  logging of avc messages output).  Does not do system-call
> -	  auditing without CONFIG_AUDITSYSCALL.
> +	---help---
> +	Enable auditing infrastructure that can be used with another
> +	kernel subsystem, such as SELinux (which requires this for
> +	logging of avc messages output).  Does not do system-call
> +	auditing without CONFIG_AUDITSYSCALL.
>  
>  Features that might still be considered unstable should be defined as
>  dependent on "EXPERIMENTAL":

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

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Geert Uytterhoeven]

On Wed, 18 Jul 2007, Jan Engelhardt wrote:
> Add some help texts to recently-introduced kconfig items
> 
> Index: linux-2.6.23/drivers/macintosh/Kconfig
> ===================================================================
> --- linux-2.6.23.orig/drivers/macintosh/Kconfig
> +++ linux-2.6.23/drivers/macintosh/Kconfig
> @@ -3,6 +3,12 @@ menuconfig MACINTOSH_DRIVERS
>  	bool "Macintosh device drivers"
>  	depends on PPC || MAC || X86
>  	default y if (PPC_PMAC || MAC)
> +	---help---
> +	  Say Y here to get to see options for devices used with Macintosh
> +	  computers, both PPC and Intel based. This option alone does not add
                                  ^^^^^
> +	  any kernel code.
> +
> +	  If you say N, all options in this submenu will be skipped and disabled.

`MAC' is the symbol for m68k Macs.

>From a quick look at drivers/macintosh/Kconfig, all of the entries are for m68k
and PPC Macs only.  The only thing that depends on X86 is the main menu...

Gr{oetje,eeting}s,

						Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
							    -- Linus Torvalds

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Stefan Richter]

Geert Uytterhoeven wrote:
> On Wed, 18 Jul 2007, Jan Engelhardt wrote:
>> Add some help texts to recently-introduced kconfig items
>>
>> Index: linux-2.6.23/drivers/macintosh/Kconfig
>> ===================================================================
>> --- linux-2.6.23.orig/drivers/macintosh/Kconfig
>> +++ linux-2.6.23/drivers/macintosh/Kconfig
>> @@ -3,6 +3,12 @@ menuconfig MACINTOSH_DRIVERS
>>  	bool "Macintosh device drivers"
>>  	depends on PPC || MAC || X86
>>  	default y if (PPC_PMAC || MAC)
>> +	---help---
>> +	  Say Y here to get to see options for devices used with Macintosh
>> +	  computers, both PPC and Intel based. This option alone does not add
>                                   ^^^^^
>> +	  any kernel code.
>> +
>> +	  If you say N, all options in this submenu will be skipped and disabled.
> 
> `MAC' is the symbol for m68k Macs.

OK, then this should read

	  Say Y here to get to see options for devices used with Macintosh
	  computers. This option alone does not add any kernel code.

	  If you say N, all options in this submenu will be skipped and disabled.

> From a quick look at drivers/macintosh/Kconfig, all of the entries are for m68k
> and PPC Macs only.  The only thing that depends on X86 is the main menu...

There is one entry for all sorts of Macs, MAC_EMUMOUSEBTN.
-- 
Stefan Richter
-=====-=-=== -=== =--==
http://arcgraph.de/sr/

Re: 2.6.22-git* regression: Kconfig prompts without help text

[Geert Uytterhoeven]

On Thu, 19 Jul 2007, Stefan Richter wrote:
> Geert Uytterhoeven wrote:
> > On Wed, 18 Jul 2007, Jan Engelhardt wrote:
> >> Add some help texts to recently-introduced kconfig items
> >>
> >> Index: linux-2.6.23/drivers/macintosh/Kconfig
> >> ===================================================================
> >> --- linux-2.6.23.orig/drivers/macintosh/Kconfig
> >> +++ linux-2.6.23/drivers/macintosh/Kconfig
> >> @@ -3,6 +3,12 @@ menuconfig MACINTOSH_DRIVERS
> >>  	bool "Macintosh device drivers"
> >>  	depends on PPC || MAC || X86
> >>  	default y if (PPC_PMAC || MAC)
> >> +	---help---
> >> +	  Say Y here to get to see options for devices used with Macintosh
> >> +	  computers, both PPC and Intel based. This option alone does not add
> >                                   ^^^^^
> >> +	  any kernel code.
> >> +
> >> +	  If you say N, all options in this submenu will be skipped and disabled.
> > 
> > `MAC' is the symbol for m68k Macs.
> 
> OK, then this should read
> 
> 	  Say Y here to get to see options for devices used with Macintosh
> 	  computers. This option alone does not add any kernel code.
> 
> 	  If you say N, all options in this submenu will be skipped and disabled.
> 
> > From a quick look at drivers/macintosh/Kconfig, all of the entries are for m68k
> > and PPC Macs only.  The only thing that depends on X86 is the main menu...
> 
> There is one entry for all sorts of Macs, MAC_EMUMOUSEBTN.

You're right, I missed that one, as I used `grep depends' ;-)

Gr{oetje,eeting}s,

						Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
							    -- Linus Torvalds