docs/64144: [patch] document procedure to add a new ports category to Committer's Guide

[Simon L. Nielsen]

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="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 
> url="../../books/porters-handbook/makefile-categories.html#PORTING-CATEGORIES">
> +		    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...

-- 
Simon L. Nielsen
FreeBSD Documentation Team
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20040330/2e8ab66a/attachment.sig>