Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 12 Aug 2001 20:42:21 -0700
From:      "David O'Brien" <obrien@freebsd.org>
To:        Joe Kelsey <joe@zircon.seattle.wa.us>
Cc:        current@freebsd.org
Subject:   Re: Documentation in FreeBSD
Message-ID:  <20010812204221.A8432@dragon.nuxi.com>
In-Reply-To: <15223.16537.621443.350921@zircon.zircon.seattle.wa.us>; from joe@zircon.seattle.wa.us on Sun, Aug 12, 2001 at 07:51:05PM -0700
References:  <15223.16537.621443.350921@zircon.zircon.seattle.wa.us>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, Aug 12, 2001 at 07:51:05PM -0700, Joe Kelsey wrote:
> OK, so we have beaten the psm and keyboard code to death.  The entire
> point that I have been trying to make in this discussion is that it is
> imperative to document design decisions somewhere that is likely to
> survive changes in maintainer.
... 
> What I am pleading for is nothing more than any commercial software
> house requires of its programmers.

And *PAYS* its programmers to do.  This is the point you are missing.
If you were to commercially sponsor some design docs, I'm sure we can get
them written.

> Certainly, we could adopt some sort of standard practice to
> embed design comments in the code.  I personally prefer to over-comment
> as it is hard to determine exactly what someone needs 5 years from now
> to fix a problem.

Send patches.  You wanted some of the PSM comments added to the code --
send a patch that adds the ones you think would have helped you.

-- 
-- David  (obrien@FreeBSD.org)

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




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