Date: Wed, 5 Apr 2000 13:45:15 -0700 (PDT) From: dhesi@rahul.net (Rahul Dhesi) To: freebsd-stable@freebsd.org Subject: Re: FreeBSD/Opensource is not free Message-ID: <20000405204515.F1DDB7C28@yellow.rahul.net> References: <freebsd-stable.Pine.BSF.4.21.0004050805470.4363-100000@earth.fxp>
next in thread | previous in thread | raw e-mail | index | archive | help
"Chris D. Faulhaber" <jedgar@fxp.org> writes:
>> To write documentation, I need authoritative information. That is hard
>> to get. If ther were design documents and programmer's notes, I could
>> take them and convert them into user manuals quite easily. But there
>> are no such documents that I have found so far....
>You seem to be forgetting the most obvious way to get information...just
>ask. Most of FreeBSD's code has the authors/maintainers names embedded in
>it somewhere. In addition to the authors/maintainers, there are many
>knowledgable people subscribed to FreeBSD's veritable plethora of
>technical mailing lists that have the knowledge that you require and would
>love to share.
Ok, I am hereby asking! All FreeBSD developers: Please insert comments
in all code from now on that fully document what the code does, what the
expected inputs are, what the expected outputs are, what the invariants
are, and what each error message means.
Have some documentation standards for the whole project that all
contributed code should (preferably must) adhere to.
I will take this raw documentation (small chunks at a time) and convert
it into user-friendly manuals.
--
Rahul Dhesi <dhesi@email.rahul.net> (spam-filtered with RSS and ORBS)
See my ORBS faq:
http://www.rahul.net/dhesi/orbs.faq.txt
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-stable" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20000405204515.F1DDB7C28>