2003-08-11 13:21:41

by Pavel Machek

[permalink] [raw]
Subject: Kconfig -- kill "if you want to read about modules, see" crap?

Hi!

Each and every input driver (and other drivers are not better)
contains this

This driver is also available as a module ( = code which can be
inserted in and removed from the running kernel whenever you want).
The module will be called input. If you want to compile it as a
module, say M here and read <file:Documentation/modules.txt>.

text. Perhaps having 1000 copies of same help test is bad idea? Maybe
CONFIG_MODULE can explain users what modules are, and we can have help
texts that are actually usefull?
Pavel
--
When do you have a heart between your knees?
[Johanka's followup: and *two* hearts?]


2003-08-11 13:35:27

by MånsRullgård

[permalink] [raw]
Subject: Re: Kconfig -- kill "if you want to read about modules, see" crap?

Pavel Machek <[email protected]> writes:

> Each and every input driver (and other drivers are not better)
> contains this
>
> This driver is also available as a module ( = code which can be
> inserted in and removed from the running kernel whenever you want).
> The module will be called input. If you want to compile it as a
> module, say M here and read <file:Documentation/modules.txt>.
>
> text. Perhaps having 1000 copies of same help test is bad idea? Maybe
> CONFIG_MODULE can explain users what modules are, and we can have help
> texts that are actually usefull?

I agree, but it would be nice to show the name of the module in the
help text. These are not always obvious.

--
M?ns Rullg?rd
[email protected]

2003-08-11 13:50:54

by John Bradford

[permalink] [raw]
Subject: Re: Kconfig -- kill "if you want to read about modules, see" crap?

> Each and every input driver (and other drivers are not better)
> contains this
>
> This driver is also available as a module ( = code which can be
> inserted in and removed from the running kernel whenever you want).
> The module will be called input. If you want to compile it as a
> module, say M here and read <file:Documentation/modules.txt>.
>
> text. Perhaps having 1000 copies of same help test is bad idea?

I totally agree. The only part that's useful is 'The module will be
called...'. We could change the whole wording to just, 'If compiled
as a module, it will be called...'.

John.

2003-08-11 18:17:59

by Steven Cole

[permalink] [raw]
Subject: Re: Kconfig -- kill "if you want to read about modules, see" crap?

On Mon, 2003-08-11 at 08:00, John Bradford wrote:
> > Each and every input driver (and other drivers are not better)
> > contains this
> >
> > This driver is also available as a module ( = code which can be
> > inserted in and removed from the running kernel whenever you want).
> > The module will be called input. If you want to compile it as a
> > module, say M here and read <file:Documentation/modules.txt>.
> >
> > text. Perhaps having 1000 copies of same help test is bad idea?
>
> I totally agree. The only part that's useful is 'The module will be
> called...'. We could change the whole wording to just, 'If compiled
> as a module, it will be called...'.
>
> John.

Here is a little patch to implement this for
drivers/input/keyboard/Kconfig for a start. The patch also fixes some
module names which were wrong (cut and paste errors).

Adding James Simmons to cc:list for patch review. If this is the right
thing to do, please send Linuswards.

Steven

--- 2.5-bk-current/drivers/input/keyboard/Kconfig Mon Aug 11 10:28:03 2003
+++ 2.5-linux/drivers/input/keyboard/Kconfig Mon Aug 11 11:38:12 2003
@@ -23,10 +23,7 @@

If unsure, say Y.

- This driver is also available as a module ( = code which can be
- inserted in and removed from the running kernel whenever you want).
- The module will be called atkbd. If you want to compile it as a
- module, say M here and read <file:Documentation/modules.txt>.
+ If compiled as a module, it will be called atkbd.

config KEYBOARD_SUNKBD
tristate "Sun Type 4 and Type 5 keyboard support"
@@ -36,10 +33,7 @@
connected either to the Sun keyboard connector or to an serial
(RS-232) port via a simple adapter.

- This driver is also available as a module ( = code which can be
- inserted in and removed from the running kernel whenever you want).
- The module will be called sunkbd. If you want to compile it as a
- module, say M here and read <file:Documentation/modules.txt>.
+ If compiled as a module, it will be called sunkbd.

config KEYBOARD_XTKBD
tristate "XT Keyboard support"
@@ -50,10 +44,7 @@
parallel port keyboard adapter, you cannot connect it to the
keyboard port on a PC that runs Linux.

- This driver is also available as a module ( = code which can be
- inserted in and removed from the running kernel whenever you want).
- The module will be called xtkbd. If you want to compile it as a
- module, say M here and read <file:Documentation/modules.txt>.
+ If compiled as a module, it will be called xtkbd.

config KEYBOARD_NEWTON
tristate "Newton keyboard"
@@ -61,10 +52,7 @@
help
Say Y here if you have a Newton keyboard on a serial port.

- This driver is also available as a module ( = code which can be
- inserted in and removed from the running kernel whenever you want).
- The module will be called maple_keyb. If you want to compile it as a
- module, say M here and read <file:Documentation/modules.txt>.
+ If compiled as a module, it will be called newtonkbd.

config KEYBOARD_MAPLE
tristate "Maple bus keyboard support"
@@ -73,10 +61,7 @@
Say Y here if you have a DreamCast console running Linux and have
a keyboard attached to its Maple bus.

- This driver is also available as a module ( = code which can be
- inserted in and removed from the running kernel whenever you want).
- The module will be called maple_keyb. If you want to compile it as a
- module, say M here and read <file:Documentation/modules.txt>.
+ If compiled as a module, it will be called maple_keyb.

config KEYBOARD_AMIGA
tristate "Amiga keyboard"
@@ -85,10 +70,7 @@
Say Y here if you are running Linux on any AMIGA and have a keyboard
attached.

- This driver is also available as a module ( = code which can be
- inserted in and removed from the running kernel whenever you want).
- The module will be called amikbd. If you want to compile it as a
- module, say M here and read <file:Documentation/modules.txt>.
+ If compiled as a module, it will be called amikbd.

config KEYBOARD_98KBD
tristate "NEC PC-9800 Keyboard support"
@@ -97,8 +79,5 @@
Say Y here if you want to use the NEC PC-9801/PC-9821 keyboard (or
compatible) on your system.

- This driver is also available as a module ( = code which can be
- inserted in and removed from the running kernel whenever you want).
- The module will be called xtkbd.o. If you want to compile it as a
- module, say M here and read <file:Documentation/modules.txt>.
+ If compiled as a module, it will be called 98kbd.




2003-08-11 18:28:12

by Dave Jones

[permalink] [raw]
Subject: Re: Kconfig -- kill "if you want to read about modules, see" crap?

On Mon, Aug 11, 2003 at 12:14:04PM -0600, Steven Cole wrote:

> Here is a little patch to implement this for
> drivers/input/keyboard/Kconfig for a start. The patch also fixes some
> module names which were wrong (cut and paste errors).

We could go one stage further, and add to Kconfig..

MODULE_NAME=atkbd

for each option, which would also allow us to only show that info
of CONFIG_MODULES=y, as well as eliminating the redundancy.

Dave

--
Dave Jones http://www.codemonkey.org.uk

2003-08-11 19:01:13

by Steven Cole

[permalink] [raw]
Subject: Re: Kconfig -- kill "if you want to read about modules, see" crap?

On Mon, 2003-08-11 at 12:24, Dave Jones wrote:
> On Mon, Aug 11, 2003 at 12:14:04PM -0600, Steven Cole wrote:
>
> > Here is a little patch to implement this for
> > drivers/input/keyboard/Kconfig for a start. The patch also fixes some
> > module names which were wrong (cut and paste errors).
>
> We could go one stage further, and add to Kconfig..
>
> MODULE_NAME=atkbd
>
> for each option, which would also allow us to only show that info
> of CONFIG_MODULES=y, as well as eliminating the redundancy.
>
> Dave

We will need to accommodate this situation:

[steven@spc5 2.5-linux]$ find . -name Makefile | xargs grep IP6_NF_MATCH_AHESP
./net/ipv6/netfilter/Makefile:obj-$(CONFIG_IP6_NF_MATCH_AHESP) += ip6t_esp.o ip6t_ah.o

Steven





2003-08-11 21:36:22

by Jim Carter

[permalink] [raw]
Subject: Re: Kconfig -- kill "if you want to read about modules, see" crap?

On Mon, 11 Aug 2003, M?ns Rullg?rd wrote:
> Pavel Machek <[email protected]> writes:
> > This driver is also available as a module ( = code which can...
> > Perhaps having 1000 copies of same help text is bad idea? ...
>
> I agree, but it would be nice to show the name of the module in the
> help text. These are not always obvious.

>From user land, one vote of agreement on both points.

James F. Carter Voice 310 825 2897 FAX 310 206 6673
UCLA-Mathnet; 6115 MSA; 405 Hilgard Ave.; Los Angeles, CA, USA 90095-1555
Email: [email protected] http://www.math.ucla.edu/~jimc (q.v. for PGP key)

2003-08-11 22:10:18

by Mike Fedyk

[permalink] [raw]
Subject: Re: Kconfig -- kill "if you want to read about modules, see" crap?

On Mon, Aug 11, 2003 at 02:36:16PM -0700, Jim Carter wrote:
> On Mon, 11 Aug 2003, M?ns Rullg?rd wrote:
> > Pavel Machek <[email protected]> writes:
> > > This driver is also available as a module ( = code which can...
> > > Perhaps having 1000 copies of same help text is bad idea? ...
> >
> > I agree, but it would be nice to show the name of the module in the
> > help text. These are not always obvious.
>
> From user land, one vote of agreement on both points.

See subthread talking about modifying Kconfig...