From owner-freebsd-doc@FreeBSD.ORG  Thu Apr  1 17:40: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 B95DA16A4CE; Thu,  1 Apr 2004 17:40:14 -0800 (PST)
Received: from shaft.techsupport.co.uk (shaft.techsupport.co.uk
	[212.250.77.214])	by mx1.FreeBSD.org (Postfix) with ESMTP
	id 2466D43D1D; Thu,  1 Apr 2004 17:40:14 -0800 (PST)
	(envelope-from setantae@submonkey.net)
Received: from cpc2-cdif3-6-0-cust204.cdif.cable.ntl.com
	([81.103.67.204] helo=shrike.submonkey.net ident=mailnull)
	by shaft.techsupport.co.uk with esmtp (TLSv1:DHE-RSA-AES256-SHA:256)
	(Exim 4.30; FreeBSD)
	id 1B9DfI-0008mq-Ng; Fri, 02 Apr 2004 02:40:12 +0100
Received: from setantae by shrike.submonkey.net with local (Exim 4.30;
	FreeBSD)	id 1B9DfF-000KIH-Mn; Fri, 02 Apr 2004 02:40:09 +0100
Date: Fri, 2 Apr 2004 02:40:09 +0100
From: Ceri Davies <ceri@FreeBSD.org>
To: Mark Linimon <linimon@lonesome.com>
Message-ID: <20040402014009.GK771@submonkey.net>
Mail-Followup-To: Ceri Davies <ceri@FreeBSD.org>,
	Mark Linimon <linimon@lonesome.com>,
	FreeBSD-gnats-submit@FreeBSD.org, freebsd-doc@FreeBSD.org,
	Oliver Eikemeier <eikemeier@fillmore-labs.com>
References: <Pine.LNX.4.44.0403301853580.6616-100000@pancho>
	<200404011413.51013.linimon@lonesome.com>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="5FDiZl1vRbLRjwwc"
Content-Disposition: inline
In-Reply-To: <200404011413.51013.linimon@lonesome.com>
X-PGP: finger ceri@FreeBSD.org
User-Agent: Mutt/1.5.4i
Sender: Ceri Davies <setantae@submonkey.net>
cc: freebsd-doc@FreeBSD.org
cc: FreeBSD-gnats-submit@FreeBSD.org
cc: Oliver Eikemeier <eikemeier@fillmore-labs.com>
Subject: Re: docs/64144: [patch] document procedure to add a new ports
	category to Committer's Guide
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: Fri, 02 Apr 2004 01:40:15 -0000


--5FDiZl1vRbLRjwwc
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, Apr 01, 2004 at 02:13:51PM -0600, Mark Linimon wrote:
> Here is an updated (hopefully final) version of the patch.  It is still
> vague on the detail of getting http://www.FreeBSD.org/ports/ updated,
> but since that seems to be still under discussion, IMHO we should
> go ahead and commit what's here and update that detail once that
> discussion is resolved.

I'm happy for you to commit this, on the proviso that this comma goes
away:

> +	      Assign the PR to the &a.portmgr; (as <literal>portmgr</literal>).
> +	      If they approve it, it will be reassigned to &a.cvs; (as
> +	      <literal>cvs</literal>), who will do a repository copy from
> +	      the old to the new locations, and reassign the PR back to you.
	                                 ^^^

And that this becomes a real word:

> +			<para>Run a <command>make describe</command>.  Since
> +			  the top-level <command>make index</command> that
> +			  you will be running in a few steps is an interation
			                                           ^^^^^^^^^^
> +			  of <command>make describe</command> over the entire
> +			  ports hierarchy, catching any errors here will
> +			  save you having to re-run that step later on.</para>

Not sure about this apostrophe either.  Do the right thing (which may be
to leave it, it's 2.30 am here):

> +		  <para>On your own local system, test the proposed
> +		    changes: first, comment out the
> +		    <makevar>SUBDIR</makevar> entries in the old
> +		    ports' categories' <filename>Makefile</filename>s;
		        ^^^

I don't like this comma either:

> +		    then, enable building the new category in
		       ^^^
> +		    <filename>ports/Makefile</filename>.

Think this semicolon should go:

> +		  <para>Once this is done, you can commit the
> +		    updated <filename>ports/Makefile</filename> to
> +		    connect the new category to the build; and also
		                                        ^^^
> +		    commit the <filename>Makefile</filename> changes
> +		    for the old category or categories.  The new
> +		    category's <filename>pkg/COMMENT</filename>
> +		    can be committed, too.</para>

It may or may not be worth mentioning that distrib/ lives in the src
repository.

> +		  <para>Update the instructions for &man.cvsup.1; by
> +		    modifying <filename>distrib/cvsup/sup/README</filename>
> +		    and adding the following files into
> +		    <filename>cvsup/sup/ports-categoryname</filename>:
> +		    <filename>list.cvs</filename> and
> +		    <filename>releases</filename>.</para>

s/both to/to both/ perhaps?

> +		  <para>Submit a docs PR to add the new category both to the
> +		    <ulink=20
> url=3D"../../books/porters-handbook/makefile-categories.html#PORTING-CATE=
GORIES">

The FDP says get rid of "the file" below (grep for "Avoid redundant
phrases"):

> +		    Porter's Handbook</ulink> and to the file
> +		    <filename>www/en/ports/categories</filename>.</para>

Ceri
--=20

--5FDiZl1vRbLRjwwc
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (FreeBSD)

iD8DBQFAbMR5ocfcwTS3JF8RAiHhAJ9eFqo1mvLgMm4PYxgE9Jb6nC6GPACgvyxA
YOtm1EO92FiEISmZl5y3zNg=
=KYIZ
-----END PGP SIGNATURE-----

--5FDiZl1vRbLRjwwc--