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

[Ceri Davies]

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

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
-- 
-------------- 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/20040402/bd13676e/attachment.sig>