From owner-freebsd-doc@FreeBSD.ORG  Tue Aug  3 22:04:14 2004
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id E642716A4CE
	for <doc@freebsd.org>; Tue,  3 Aug 2004 22:04:14 +0000 (GMT)
Received: from ns1.tiadon.com (SMTP.tiadon.com [69.27.132.161])
	by mx1.FreeBSD.org (Postfix) with ESMTP id AA77F43D1D
	for <doc@freebsd.org>; Tue,  3 Aug 2004 22:04:14 +0000 (GMT)
	(envelope-from kdk@daleco.biz)
Received: from [69.27.131.0] ([69.27.131.0]) by ns1.tiadon.com with Microsoft
	SMTPSVC(6.0.3790.0);	 Tue, 3 Aug 2004 17:07:50 -0500
Message-ID: <41100BDC.9070503@daleco.biz>
Date: Tue, 03 Aug 2004 17:04:12 -0500
From: "Kevin D. Kinsey, DaleCo, S.P." <kdk@daleco.biz>
User-Agent: Mozilla/5.0 (X11; U; FreeBSD i386; en-US; rv:1.7) Gecko/20040712
X-Accept-Language: en-us, en
MIME-Version: 1.0
To: Allon Stern <allon@fgm.com>
References: <48D752FF-E590-11D8-A4BC-000393598558@fgm.com>
In-Reply-To: <48D752FF-E590-11D8-A4BC-000393598558@fgm.com>
Content-Type: text/plain; charset=windows-1252; format=flowed
Content-Transfer-Encoding: 7bit
X-OriginalArrivalTime: 03 Aug 2004 22:07:51.0448 (UTC)
	FILETIME=[51A47180:01C479A6]
cc: doc@freebsd.org
Subject: Re: documentation clarification
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 03 Aug 2004 22:04:15 -0000

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