Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 22 Jun 1999 18:02:52 +0930
From:      Greg Lehey <grog@lemis.com>
To:        Mike Smith <mike@smith.net.au>
Cc:        hm@hcs.de, dfr@nlsystems.com, peter@FreeBSD.org, cvs-all@FreeBSD.org, FreeBSD Hackers <hackers@FreeBSD.org>
Subject:   All this and documentation too? (was: cvs commit: src/sys/isa sio.c)
Message-ID:  <19990622180252.J76907@freebie.lemis.com>
In-Reply-To: <199906220823.BAA01443@dingo.cdrom.com>; from Mike Smith on Tue, Jun 22, 1999 at 01:23:24AM -0700
References:  <m10wLVh-0000fqC@hcswork.hcs.de> <199906220823.BAA01443@dingo.cdrom.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Tuesday, 22 June 1999 at  1:23:24 -0700, Mike Smith wrote:
>>
>> Anyway, i don't think you are asking for too much - of what use is a shiny
>> new design of a new subsystem in the very basic FreeBSD architecture if just
>> some handful few people knew how it works and how to use it ?
>
> Gosh, that would make it just like every other shiny new subsystem.
>
> Folks, just cut the carping and write your own documentation.  The
> architects can't,

Of course they can.

> and won't write it for you.

And they might, too.  phk has frequently expressed a desire to either
write documentation on existing systems, or at least help others do
so.  I'm in the process of writing technical docs for Vinum.  The
biggest problem is knowing what to write and how to describe it.

> It has never happened that way (anywhere, on any project), 

Of course it has.  It's just uncommon in the FreeBSD environment.  In
many large projects, you don't do any code until you have a clear
definition of what you're going to do.

> and it never will.

My father never had a computer, and his father never did, so I never
will have one.  What an argument.

> Documentation is written after the fact, by someone else.

That's the worst kind of documentation.  In fact, most UNIX
documentation is written by the authors.  After the fact, admittedly.

Hopefully the change of subject line and recipients will get some more
representative views on this subject.

Greg
--
See complete headers for address, home page and phone numbers
finger grog@lemis.com for PGP public key


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990622180252.J76907>