Linux-kernel mailing list archive 2000-26,: A simpler proposal (Re: linux-kernel-documentation)

# A simpler proposal (Re: linux-kernel-documentation)

Gary Lawrence Murphy (garym@canada.com)
29 Jun 2000 11:37:08 -0400

- Messages sorted by: [ date ][ thread ][ subject ][ author ]
- Next message: Michael Bacarella: "Re: 2.2.17pre9 can't allocate more than 900MB"
- Previous message: Douglas Gilbert: "Re: Discussion to change SD_TIMEOUT in the sd"

>>>>> "C" == Copeland, Matthew <Matthew.Copeland@Honeywell.com> writes:

C> Possible Tasks:

C> 1. Beef up documentation in linux/Documentation making it more
C> clear and verbose.

I would like to add one rush-order job related to this: Anyone who is
a technical writer, please apply your talents to Configure.help.

This file needs to be double checked for accuracy, edited for clarity
and the missing parts filled out. For example, and I am _not_
complaining (I'm grateful for _any_ docs we get), this is just one
illustration out of many::

Since various rules were applied and created ... et al. as it relates
the detection of vaild cable signals. This is a result of unclear terms
in ATA-4 and ATA-5 standards.

Now I know the author knows what this means and the obtuseness is not
their fault --- they have graciously given us what they could. I also
figure that if I knew what it meant, I'd use the option but since I
don't, I won't, but that shouldn't be the case --- Configure.help is
probably the first kernel document file presented to the general
public (to those brave enough to attempt to tune their kernel).

If we truly want to help the cause of Linux documentation, this file
should be our top priority.

Eric may correct me on this, but I believe Configure.help will survive
the upgrade to CML2, so the work we do on this file is not throw away.

If nothing else in linux/Documentation is revised and copy-edited
before the 2.4 kernel starts appearing in the distros, we should at
least apply our art to Configure.help.

    --
    Gary Lawrence Murphy <garym@linux.ca>: office voice/fax: 01 519 4222723
    T(C)Inc Business Innovations through Open Source http://www.teledyn.com
    M:I-3 - Documenting the Linux kernel: http://kernelbook.sourceforge.net
    "Computers are useless.  They can only give you answers."(Pablo Picasso)

    -
    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/

- Next message: Michael Bacarella: "Re: 2.2.17pre9 can't allocate more than 900MB"
- Previous message: Douglas Gilbert: "Re: Discussion to change SD_TIMEOUT in the sd"