Skip to contentSkip to conversation

This month's price for the most useless new Kconfig help text ...

DISCUSSION Andi Kleen 5 participants 8 messages May 1, 2008

lore
Share & tools
lore

Andi Kleen

author
#0 lore raw

<drumroll> ... gets CONFIG_ACCESSIBILITY

menuconfig ACCESSIBILITY
bool "Accessibility support"
---help---
Enable a submenu where accessibility items may be enabled.

One can only guess what is meant by accessbility when asked that by oldconfig (don't explain, I know it now) and the help text has about 0% additional information over the CONFIG name.

Can the help text be improved please? It should explain that accessibility in this case means braille device drivers and possibly other similar devices.

Thanks,

-Andi

#1 lore raw
Quoted 9 lines · Andi Kleen, le Thu 01 May 2008 14:09:59 +0200, a écrit :

<drumroll> ... gets CONFIG_ACCESSIBILITY

menuconfig ACCESSIBILITY
bool "Accessibility support"
---help---
Enable a submenu where accessibility items may be enabled.

Can the help text be improved please? It should explain that accessibility in this case means braille device drivers and possibly other similar devices.

If the society was a bit more aware of accessibility troubles in general (I mean in the street etc.), we wouldn't have to explain the word </grin>.

Samuel

Add a small explanation of what accessibility is.

drivers/accessibility/Kconfig renamed from drivers/accessibility/Kconfig.orig +7 -0
@@ -3,6 +3,13 @@
 	---help---
 	  Enable a submenu where accessibility items may be enabled.
 
+	  Accessibility handles all special kinds of hardware devices or
+	  software adapters which help people with disabilities (e.g.
+	  blindness) to use computers.
+
+	  That includes braille devices, speech synthesis, keyboard
+	  remapping, etc.
+
 	  If unsure, say N.
 
 if ACCESSIBILITY
#2 lore raw
Quoted 2 lines · Samuel Thibault

If the society was a bit more aware of accessibility troubles in general (I mean in the street etc.), we wouldn't have to explain the word

Blah, an agenda is not an excuse for bad option descriptions.

And btw, the word accessibility in the sense used here doesn't translate at all into many foreign languages, so the 90% of kernel hackers and users not native speakers or involved with accessibility would be helped with it anyway.

#3 lore raw
Quoted 5 lines · Christoph Hellwig, le Thu 01 May 2008 11:47:20 -0400, a écrit :
Quoted 2 lines · Samuel Thibault

If the society was a bit more aware of accessibility troubles in general (I mean in the street etc.), we wouldn't have to explain the word

Blah, an agenda is not an excuse for bad option descriptions.

Sure, that's why I provided a patch :)

(I agree that Kconfig helps like "CONFIG_FUSION: Say Y here to get to see options for Fusion Message Passing Technology (MPT) drivers" do not help much, I just didn't know that people were now actually caring about having some real explanations beyond the usual "if you don't know what it is, you don't need it, just say no")

Quoted 2 lines

And btw, the word accessibility in the sense used here doesn't translate at all into many foreign languages,

Right.

Samuel

#4 lore raw
Quoted 7 lines · On Thursday, 1 May 2008 19:01:29 Samuel Thibault wrote:
Quoted 5 lines · Christoph Hellwig, le Thu 01 May 2008 11:47:20 -0400, a écrit :
Quoted 2 lines · Samuel Thibault

If the society was a bit more aware of accessibility troubles in general (I mean in the street etc.), we wouldn't have to explain the word

Blah, an agenda is not an excuse for bad option descriptions.

Quoted 7 lines

Sure, that's why I provided a patch :)

(I agree that Kconfig helps like "CONFIG_FUSION: Say Y here to get to see options for Fusion Message Passing Technology (MPT) drivers" do not help much, I just didn't know that people were now actually caring about having some real explanations beyond the usual "if you don't know what it is, you don't need it, just say no")

Speaking of which I remember how I was confused when I found out that this driver is the linux driver for "SCI logic" SCSI vmware adapter :-)

Quoted 4 lines
Quoted 3 lines

And btw, the word accessibility in the sense used here doesn't translate at all into many foreign languages,

Quoted 9 lines

Right.

Samuel
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

Regards,
Maxim Levitsky

#5 lore raw
In reply to Samuel Thibault
Quoted 4 lines · Samuel Thibault
drivers/accessibility/Kconfig renamed from drivers/accessibility/Kconfig.orig +0 -0
@@ -3,6 +3,13 @@
 	---help---

drivers/accessibility/Kconfig line 13

Quoted 10 lines
drivers/accessibility/Kconfig renamed from drivers/accessibility/Kconfig.orig +7 -0
 	  Enable a submenu where accessibility items may be enabled.
 
+	  Accessibility handles all special kinds of hardware devices or
+	  software adapters which help people with disabilities (e.g.
+	  blindness) to use computers.
+
+	  That includes braille devices, speech synthesis, keyboard
+	  remapping, etc.
+
 	  If unsure, say N.

Would you mind replacing also the first sentence by something which indicates whether this option alone already changes the kernel build?

Look at the help texts of other menuconfig option items. Random pick: NETDEV_1000:
[...]
Say Y here to get to see options for 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.

Signature · 3 lines
Stefan Richter
-=====-==--- -=-= ----=
http://arcgraph.de/sr/
#6 lore raw
Quoted 9 lines · Stefan Richter, le Thu 01 May 2008 19:36:25 +0200, a écrit :
Quoted 8 lines · Samuel Thibault

--- linux/drivers/accessibility/Kconfig.orig 2008-05-01
14:13:03.000000000 +0100
+++ linux/drivers/accessibility/Kconfig 2008-05-01
14:12:50.000000000 +0100

(quoted diff) +0 -0
@@ -3,6 +3,13 @@
 	---help---
 	  Enable a submenu where accessibility items may be enabled.
 
Quoted 11 lines

Review line 13

Quoted 8 lines
(quoted diff) +7 -0
+	  Accessibility handles all special kinds of hardware devices or
+	  software adapters which help people with disabilities (e.g.
+	  blindness) to use computers.
+
+	  That includes braille devices, speech synthesis, keyboard
+	  remapping, etc.
+
 	  If unsure, say N.

Would you mind replacing also the first sentence by something which indicates whether this option alone already changes the kernel build?

Here it is.

Samuel

Indicate that enabling just CONFIG_ACCESSIBILITY does not add code.

drivers/accessibility/Kconfig renamed from drivers/accessibility/Kconfig.orig +5 -2
@@ -1,8 +1,6 @@
 menuconfig ACCESSIBILITY
 	bool "Accessibility support"
 	---help---
-	  Enable a submenu where accessibility items may be enabled.
-
 	  Accessibility handles all special kinds of hardware devices or
 	  software adapters which help people with disabilities (e.g.
 	  blindness) to use computers.
@@ -10,6 +8,11 @@
 	  That includes braille devices, speech synthesis, keyboard
 	  remapping, etc.
 
+	  Say Y here to get to see options for accessibility.
+	  This option alone does not add any kernel code.
+
+	  If you say N, all options in this submenu will be skipped and disabled.
+
 	  If unsure, say N.
 
 if ACCESSIBILITY
#7 lore raw

Thanks Samuel. This way 'make oldconfig' and friends are less irritating.

Signature · 3 lines
Stefan Richter
-=====-==--- -=-= ----=
http://arcgraph.de/sr/