KISS driver help message

Alex Holden (alex@linuxhacker.org)
Thu, 17 Sep 1998 18:05:02 +0100 (BST)


This message is in MIME format. The first part should be readable text,
while the remaining parts are likely unreadable without MIME-aware tools.
Send mail to mime@docserver.cac.washington.edu for more info.

---2144583408-704991305-906051902=:4323
Content-Type: TEXT/PLAIN; charset=US-ASCII

Has anyone noticed the Configure.help message about KISS?
I've attached a quick patch for it.

I think whoever wrote it must have misunderstood the comment at the top of
mkiss.c which confusingly compares it to slip.c for some reason.
For the record, KISS (Keep It Simple, Stupid) is a similar thing to 6PACK,
but has less functionality and is older and far more commonly used.

Whilst I'm here, a couple of gripes about the help messages:

1. Why do so many people spend weeks writing and debugging a driver then
not bother to spend even five minutes to write a Configure.help entry
for it? Even if it used poor English and bad grammar, there are plenty
of people who could fix that. Perhaps Linus should extend the
requirements for the inclusion of a new driver to including an
appropriate Configure.help entry for it (and preferrably some proper
documentation as well)? I hate seeing a new option with a cryptic name
appear, and looking at the help to find out more about it, only to
find "There is no help available for this Kernel option". Eg. what the
heck is a Comtrol Hostess SV-11?

2. What's the idea with all the patronising "to browse the WWW, you need
to have access to...", and "If you want to compile this driver as a
module..." comments which are repeated over and over again? I somehow
think that anyone who has got to the stage of wanting to compile the
Linux Kernel will have some idea of what the Internet is and be able
to figure out that you need a web browser to browse the web without
the help of every other Linux kernel driver help message. As for
modules, whilst I agree that mentioning that the driver can be used as
a module and saying what the module will be called is a good idea,
users don't need to be told to read Documentation/modules.txt by nearly
every help message (most probably won't bother to read it anyway until
it fails to work because they missed out the make modules and
modules_install or something). Are these throwbacks to the days when
Internet access was not common and modules were a new thing to Linux?

Best wishes, Alex.

--------------- Linux- the choice of a GNU generation. --------------
: Alex Holden (M1CJD)- Caver, Programmer, Land Rover nut, Radio Ham :
-------------------- http://www.linuxhacker.org/ --------------------

---2144583408-704991305-906051902=:4323
Content-Type: TEXT/PLAIN; charset=US-ASCII; name="kisshelp.diff"
Content-Transfer-Encoding: BASE64
Content-ID: <Pine.LNX.3.96.980917180501.4323B@hyperspace.m1cjd.ampr.org>
Content-Description:

LS0tIGxpbnV4L0RvY3VtZW50YXRpb24vQ29uZmlndXJlLmhlbHAJVGh1IFNl
cCAxNyAxNTo0ODowOSAxOTk4DQorKysgbGludXgvRG9jdW1lbnRhdGlvbi9D
b25maWd1cmUuaGVscAlUaHUgU2VwIDE3IDE3OjA0OjA1IDE5OTgNCkBAIC0y
Nzc3LDEyICsyNzc3LDEyIEBADQogDQogU2VyaWFsIHBvcnQgS0lTUyBkcml2
ZXIgZm9yIEFYLjI1DQogQ09ORklHX01LSVNTDQotICBLSVNTIGlzIGEgcHJv
dG9jb2wgdXNlZCB0byBzZW5kIElQIHRyYWZmaWMgb3ZlciBBWC4yNSByYWRp
bw0KLSAgY29ubmVjdGlvbnMsIHNvbWV3aGF0IHNpbWlsYXIgdG8gU0xJUCBm
b3IgdGVsZXBob25lIGxpbmVzLiBTYXkgWQ0KLSAgaGVyZSBpZiB5b3UgaW50
ZW5kIHRvIHNlbmQgSW50ZXJuZXQgdHJhZmZpYyBvdmVyIGFtYXRldXIgcmFk
aW8sDQotICB1c2luZyBzb21lIGRldmljZSBjb25uZWN0ZWQgdG8geW91ciBt
YWNoaW5lJ3Mgc2VyaWFsIHBvcnQuIEluIHRoYXQNCi0gIGNhc2UsIHlvdSBh
bHNvIGhhdmUgdG8gc2F5IFkgdG8gIkFtYXRldXIgUmFkaW8gQVguMjUgTGV2
ZWwgMiINCi0gIHN1cHBvcnQuICANCisgIEtJU1MgaXMgYSBwcm90b2NvbCB1
c2VkIGZvciB0aGUgZXhjaGFuZ2Ugb2YgZGF0YSBiZXR3ZWVuIGEgY29tcHV0
ZXINCisgIGFuZCBhIFRlcm1pbmFsIE5vZGUgQ29udHJvbGxlciAoYSBzbWFs
bCBlbWJlZGRlZCBzeXN0ZW0gY29tbW9ubHkNCisgIHVzZWQgZm9yIG5ldHdv
cmtpbmcgb3ZlciBBWDI1IGFtYXRldXIgcmFkaW8gY29ubmVjdGlvbnMpLg0K
KyAgQWx0aG91Z2ggS0lTUyBpcyBsZXNzIGFkdmFuY2VkIHRoYW4gdGhlIDZw
YWNrIHByb3RvY29sLCBpdCBoYXMNCisgIHRoZSBhZHZhbnRhZ2UgdGhhdCBp
dCBpcyBhbHJlYWR5IHN1cHBvcnRlZCBieSBtb3N0IG1vZGVybiBUTkNzDQor
ICB3aXRob3V0IHRoZSBuZWVkIGZvciBhIGZpcm13YXJlIHVwZ3JhZGUuDQog
DQogICBJZiB5b3Ugd2FudCB0byBjb21waWxlIHRoaXMgZHJpdmVyIGFzIGEg
bW9kdWxlICggPSBjb2RlIHdoaWNoIGNhbiBiZQ0KICAgaW5zZXJ0ZWQgaW4g
YW5kIHJlbW92ZWQgZnJvbSB0aGUgcnVubmluZyBrZXJuZWwgd2hlbmV2ZXIg
eW91IHdhbnQpLA0K
---2144583408-704991305-906051902=:4323--

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.rutgers.edu
Please read the FAQ at http://www.tux.org/lkml/