Re: [Rt2400-devel] rt2x00: cleanup Kconfig help

[Filipus Klutiero <chealer@gmail.com>]

Le April 12, 2008 04:53:16 pm Ivo van Doorn, vous avez =E9crit=A0:
[...]
>=20
> > > I send a patch that fixed this line several weeks/months ago upst=
ream.
> > >=20
> > > >  	  When building one of the individual drivers, the rt2x00 lib=
rary
> > > >  	  will also be created. That library (when the driver is buil=
t as
> > > > @@ -38,12 +38,12 @@
> > > >  	select INPUT_POLLDEV
> > > > =20
> > > >  config RT2400PCI
> > > > -	tristate "Ralink rt2400 pci/pcmcia support"
> > > > +	tristate "Ralink RT2400 (PCI/PCMCIA) support"
> > >=20
> > > Can't see a real reason for either capatilizing RT or PCI/PCMCIA =
=2E..
> > rtxxxx refer to the drivers. "rt" is capitalized in the name of the=
 chips. For PCI and PCMCIA, these are abbreviations.
>=20
> Well the names of the drivers are after the names of the chipset. So =
the rt can stay as it is now.
They are, but all driver names are lowercase, so capitalization was los=
t. The chip names really use capitals.
>=20
> Convention seems to be that PCI, PCMCIA and USB are capilitized so th=
at change is fine,
> but please make it consistent for all drivers like it currently is. S=
o either put them all between braces or none of them.
OK, I put all in parentheses in the following update.
>=20
> > > >  config RT61PCI
> > > > -	tristate "Ralink rt61 pci/pcmcia support"
> > > > +	tristate "Ralink RT2561, RT2661 support"
> > >=20
> > > Since we are setting the bus type clearly everywhere else,
> > > we shouldn't remove it here...
> > The reason I changed it is because the abbreviations weren't capita=
lized, but I simply removed it since RT2561 and RT2661 are only used in=
 PCI (or PCMCIA) devices.
>=20
> So? rt2400 is only for PCI and rt73 is only for USB. That doesn't mat=
ter.
> This way it is clearer to everybody what kind of device we are talkin=
g about.
It should already be clear to experienced people if the device is USB o=
r PCI. For simple users, they know what they own.
> It is also consistent with the other rt2x00 driver entries.

[...]

> > >=20
> > > >  	  hardware button to control the radio state.
> > > >  	  This feature depends on the RF switch subsystem rfkill.
> > > > =20
> > > >  config RT2500USB
> > > > -	tristate "Ralink rt2500 usb support"
> > > > +	tristate "Ralink RT2500USB support"
> > >=20
> > > Original version was fine since it is consistent with the rest...
> > See bug #10440. "RT2500" refers to the RT2500 (PCI or PCMCIA) chips=
et.
>=20
> So you mean that stating "rt2500 usb" makes people confused to think =
it is a pci device?
> The usb label is already mentioned in the subject....
>=20
> rt2500 is _not_ PCI only, the USB version is the same chipset pasted =
on a different busconnector.
I'm not really knowledgeable in Ralink, but according to http://ralink.=
rapla.net/ RT2500USB uses different RF and MAC chips than RT2500. Maybe=
 you know better.

[...]
> > >=20
> > > >  	  When compiled as a module, this driver will be called "rt25=
00usb.ko".
> > > > =20
> > > >  config RT73USB
> > > > -	tristate "Ralink rt73 usb support"
> > > > +	tristate "Ralink RT2571W (USB) support"
> > >=20
> > > consistency and don't forget to add all types.
> > > tristate "Ralink rt2571W & rt2671 usb support"
> > You must know better than me if RT2671 is also supported. I didn't =
mean that my patch fixed everything.
>=20
> I just added it so you can add it when you rebase your patch based on=
 my comments.
> It is just for completeness.
I added it, but I don't know which chipset(s) use RT2671, so the new pa=
tch is somewhat incomplete.
>=20
> > > >  	depends on RT2X00 && USB
> > > >  	select RT2X00_LIB_USB
> > > >  	select RT2X00_LIB_FIRMWARE
> > > >  	---help---
> > > > -	  This is an experimental driver for the Ralink rt73 wireless=
 chip.
> > > > +	  This is an experimental driver for the Ralink RT2501USB and=
 RT5201USB wireless chipsets.
> > >=20
> > > Those devices doesn't match the config title, so it should be som=
ething like:
> > >=20
> > > This is an experimental driver for the Ralink rt2571W and rt2671 =
wireless chipsets.
> > Other extended descriptions only refer to the chipsets. I think the=
 chipset should be mentioned because users are more likely to know it t=
han the MAC chip. OTOH, nothing prevents us from mentioning both.
>=20
> What I am saying is that it will be confusing when the config option =
subject mentions chip A while
> the help text mentions chip B. And this patch was focussed on making =
the text more clear.
Yes, but it's IMHO more important that users that only know the chipset=
 can find the driver. Anyway, I added the supported chips too.
---

--- drivers/net/wireless/rt2x00/Kconfig	2008-01-24 17:58:37.000000000 -=
0500
+++ drivers/net/wireless/rt2x00/Kconfig.USB	2008-04-12 18:12:06.0000000=
00 -0400
@@ -2,10 +2,10 @@
 	tristate "Ralink driver support"
 	depends on MAC80211 && WLAN_80211 && EXPERIMENTAL
 	---help---
-	  This will enable the experimental support for the Ralink drivers,
+	  This enables the experimental support for the Ralink drivers,
 	  developed in the rt2x00 project <http://rt2x00.serialmonkey.com>.
=20
-	  These drivers will make use of the Devicescape ieee80211 stack.
+	  These drivers use the mac80211 stack.
=20
 	  When building one of the individual drivers, the rt2x00 library
 	  will also be created. That library (when the driver is built as
@@ -38,12 +38,12 @@
 	select INPUT_POLLDEV
=20
 config RT2400PCI
-	tristate "Ralink rt2400 pci/pcmcia support"
+	tristate "Ralink RT2400 (PCI/PCMCIA) support"
 	depends on RT2X00 && PCI
 	select RT2X00_LIB_PCI
 	select EEPROM_93CX6
 	---help---
-	  This is an experimental driver for the Ralink rt2400 wireless chip.
+	  This is an experimental driver for the Ralink RT2400 wireless chips=
et.
=20
 	  When compiled as a module, this driver will be called "rt2400pci.ko=
".
=20
@@ -52,17 +52,17 @@
 	depends on RT2400PCI
 	select RT2X00_LIB_RFKILL
 	---help---
-	  This adds support for integrated rt2400 devices that feature a
+	  This adds support for integrated RT2400 devices that feature a
 	  hardware button to control the radio state.
 	  This feature depends on the RF switch subsystem rfkill.
=20
 config RT2500PCI
-	tristate "Ralink rt2500 pci/pcmcia support"
+	tristate "Ralink RT2500 (PCI/PCMCIA) support"
 	depends on RT2X00 && PCI
 	select RT2X00_LIB_PCI
 	select EEPROM_93CX6
 	---help---
-	  This is an experimental driver for the Ralink rt2500 wireless chip.
+	  This is an experimental driver for the Ralink RT2500 wireless chips=
et.
=20
 	  When compiled as a module, this driver will be called "rt2500pci.ko=
".
=20
@@ -71,18 +71,18 @@
 	depends on RT2500PCI
 	select RT2X00_LIB_RFKILL
 	---help---
-	  This adds support for integrated rt2500 devices that feature a
+	  This adds support for integrated RT2500 devices that feature a
 	  hardware button to control the radio state.
 	  This feature depends on the RF switch subsystem rfkill.
=20
 config RT61PCI
-	tristate "Ralink rt61 pci/pcmcia support"
+	tristate "Ralink RT2561 and RT2661 (PCI) support"
 	depends on RT2X00 && PCI
 	select RT2X00_LIB_PCI
 	select RT2X00_LIB_FIRMWARE
 	select EEPROM_93CX6
 	---help---
-	  This is an experimental driver for the Ralink rt61 wireless chip.
+	  This is an experimental driver for the Ralink RT2600 and RT2501 [Tu=
rbo] (PCI) wireless chipsets.
=20
 	  When compiled as a module, this driver will be called "rt61pci.ko".
=20
@@ -91,26 +91,26 @@
 	depends on RT61PCI
 	select RT2X00_LIB_RFKILL
 	---help---
-	  This adds support for integrated rt61 devices that feature a
+	  This adds support for integrated RT2600 and RT2501 devices that fea=
ture a
 	  hardware button to control the radio state.
 	  This feature depends on the RF switch subsystem rfkill.
=20
 config RT2500USB
-	tristate "Ralink rt2500 usb support"
+	tristate "Ralink RT2500USB support"
 	depends on RT2X00 && USB
 	select RT2X00_LIB_USB
 	---help---
-	  This is an experimental driver for the Ralink rt2500 wireless chip.
+	  This is an experimental driver for the Ralink RT2500USB wireless ch=
ipset.
=20
 	  When compiled as a module, this driver will be called "rt2500usb.ko=
".
=20
 config RT73USB
-	tristate "Ralink rt73 usb support"
+	tristate "Ralink RT2571W and RT2671 (USB) support"
 	depends on RT2X00 && USB
 	select RT2X00_LIB_USB
 	select RT2X00_LIB_FIRMWARE
 	---help---
-	  This is an experimental driver for the Ralink rt73 wireless chip.
+	  This is an experimental driver for the RT2571W and RT2671 MAC/BBP c=
hips. It supports Ralink RT2501USB and RT5201USB wireless chipsets.
=20
 	  When compiled as a module, this driver will be called "rt73usb.ko".
=20
--
To unsubscribe from this list: send the line "unsubscribe linux-wireles=
s" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html