Date: Tue, 03 Aug 2004 17:04:12 -0500 From: "Kevin D. Kinsey, DaleCo, S.P." <kdk@daleco.biz> To: Allon Stern <allon@fgm.com> Cc: doc@freebsd.org Subject: Re: documentation clarification Message-ID: <41100BDC.9070503@daleco.biz> In-Reply-To: <48D752FF-E590-11D8-A4BC-000393598558@fgm.com> References: <48D752FF-E590-11D8-A4BC-000393598558@fgm.com>
next in thread | previous in thread | raw e-mail | index | archive | help
Allon Stern wrote:
> where does one send corrections/clarifications for documentation
> related to FreeBSD?
>
I'm not expert, and don't play one on TV, but this
seems to work pretty well:
1. Find the offending source file and make a copy.
2. Edit the copied file as desired, keeping appropriate
SGML tags, etc., in place.
3. Create a patch:
diff -nu sourcefile myedit > sourcefile.patch
4. Create a problem report using send-pr(1), and
include the patch inline after the pre-formatted
stuff. Your PR's title string should be something
like this:
(PATCH) foobar(1) seg faults when used with "-R" switch
or:
(PATCH) fix of spelling errors in handbook chapter 3
Specific guidelines for the documentation team (that
you would probably want to read, also) are in the "FDP
Primer" [/usr/share/doc/en/books/fdp-primer; also available
at the www site].
Kevin Kinsey
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?41100BDC.9070503>