From owner-freebsd-doc@FreeBSD.ORG  Tue Mar 30 12:12:12 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 DE18416A4CE; Tue, 30 Mar 2004 12:12:12 -0800 (PST)
Received: from arthur.nitro.dk (port324.ds1-khk.adsl.cybercity.dk
	[212.242.113.79])	by mx1.FreeBSD.org (Postfix) with ESMTP
	id 4BF5A43D1D; Tue, 30 Mar 2004 12:12:12 -0800 (PST)
	(envelope-from simon@arthur.nitro.dk)
Received: by arthur.nitro.dk (Postfix, from userid 3000)
	id DF9E011907; Tue, 30 Mar 2004 22:12:10 +0200 (CEST)
Date: Tue, 30 Mar 2004 22:12:10 +0200
From: "Simon L. Nielsen" <simon@FreeBSD.org>
To: Mark Linimon <linimon@lonesome.com>
Message-ID: <20040330201210.GA749@arthur.nitro.dk>
References: <200403120710.i2C7A146012080@freefall.freebsd.org>
	<200403301233.26078.linimon@lonesome.com>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="OgqxwSJOaUobr8KG"
Content-Disposition: inline
In-Reply-To: <200403301233.26078.linimon@lonesome.com>
User-Agent: Mutt/1.5.6i
cc: freebsd-doc@FreeBSD.org
cc: FreeBSD-gnats-submit@FreeBSD.org
cc: eik@FreeBSD.org
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: Tue, 30 Mar 2004 20:12:13 -0000


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

On 2004.03.30 12:33:26 -0600, Mark Linimon wrote:
> Here is a revised patch that incorporates feedback that I got from
> eik@, and my own slightly improved knowledge of both the underlying
> problems, and of DocBook.

Looks good in general, but a few comments :

[CUT]

> +		<step>
> +		  <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;
> +		    then, enable building the new category in
> +		    <filename>ports/Makefile</filename>.
> +		    Run <command>make checksubdirs</command> in the
> +		    affected category directories to check the
> +		    <makevar>SUBDIR</makevar> entries.  Next, in
> +		    the <filename>ports/</filename> directory, run

Should be :

+		    the <filename class=3D"directory">ports/</filename> directory, run

[CUT]

> +		<step>
> +		  <para>Update the instructions for
> +		    <command>cvsup(1)</command> by modifying

Here you should use &man.cvsup.1;.

> +		    <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>
> +		</step>
> +
> +		<step>
> +		  <para>Submit a PR to add the new category both to the
> +		    <ulink=20
> url=3D"../../books/porters-handbook/makefile-categories.html#PORTING-CATE=
GORIES">
> +		    Porter's Handbook</ulink> and to the file
> +		    <filename>www/en/ports/categories</filename>,
> +		    and assign it to <literal>docs</literal>.</para>

If the category is set to "docs" there is no need to reassign it.  It
will automatically be assigned to freebsd-doc.

> +		</step>
> +
> +		<step>
> +		  <para>Submit a PR to request that the web
> +		    page build be updated to reflect the new
> +		    category.  The responsibility for doing this
> +		    is not yet well established.</para>
> +		</step>

Shouldn't this just be a "www" PR?  I'm not really sure what needs to be
changed on the web pages?

Of course the issue with the ports/ pages being based on a INDEX still
exist...

--=20
Simon L. Nielsen
FreeBSD Documentation Team

--OgqxwSJOaUobr8KG
Content-Type: application/pgp-signature
Content-Disposition: inline

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

iD8DBQFAadSah9pcDSc1mlERAtxyAJ4/iyF6Ijqd7HIChWmqG4O7v1s8jgCfXkr/
yRFadwmFGQsIUEEJQpbZA9w=
=6K8P
-----END PGP SIGNATURE-----

--OgqxwSJOaUobr8KG--