Update the section on creating new categories. Some of the information
was redundant with text in the Porter's Handbook. Add text about what portmgr is supposed to do. Provide links to documentation that needs to be changed. Mention the CVSup examples. Reviewed for content by: pav
This commit is contained in:
Mark Linimon
parent
4987cf4f33
commit
5180efcbeb
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=26289
1 changed files with 56 additions and 28 deletions
|
|
@ -729,11 +729,11 @@ alias scvs env CVS_RSH=ssh cvs -d <replaceable>user</replaceable>@ncvs.FreeBSD.o
|
|||
</itemizedlist>
|
||||
|
||||
<para>You will almost certainly get a conflict because
|
||||
of the <literal>$Id: article.sgml,v 1.229 2005-09-11 08:14:08 joel Exp $</literal> (or in FreeBSD's case,
|
||||
of the <literal>$Id: article.sgml,v 1.230 2005-11-09 01:25:27 linimon Exp $</literal> (or in FreeBSD's case,
|
||||
<literal>$<!-- stop expansion -->FreeBSD<!-- stop expansion -->$</literal>)
|
||||
lines, so you will have to edit the file to resolve the conflict
|
||||
(remove the marker lines and the second <literal>$Id: article.sgml,v 1.229 2005-09-11 08:14:08 joel Exp $</literal> line,
|
||||
leaving the original <literal>$Id: article.sgml,v 1.229 2005-09-11 08:14:08 joel Exp $</literal> line intact).</para>
|
||||
(remove the marker lines and the second <literal>$Id: article.sgml,v 1.230 2005-11-09 01:25:27 linimon Exp $</literal> line,
|
||||
leaving the original <literal>$Id: article.sgml,v 1.230 2005-11-09 01:25:27 linimon Exp $</literal> line intact).</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
|
|
@ -2666,16 +2666,29 @@ docs:Documentation Bug:freebsd-doc:</programlisting>
|
|||
</question>
|
||||
|
||||
<answer>
|
||||
<para>A developer who wishes to propose a new category
|
||||
should submit a detailed rationale for the new category,
|
||||
including why existing categories are not sufficient,
|
||||
and the list of ports proposed to move.</para>
|
||||
<para>Please see
|
||||
<ulink url="&url.books.porters-handbook;/makefile-categories.html#PROPOSING-CATEGORIES">
|
||||
Proposing a New Category</ulink> in the Porter's Handbook.
|
||||
Once that procedure has been followed and the PR has been
|
||||
assigned to &a.portmgr;, it is their decision whether or
|
||||
not to approve it. If they do, it is their responsibility
|
||||
to do the following:</para>
|
||||
|
||||
<para>Before submitting, keep in mind that there is a fair
|
||||
amount of work involved from multiple parties; that the
|
||||
changes affect everyone who wants to keep up-to-date with
|
||||
the entire ports tree; and that such proposals tend to
|
||||
attract controversy.</para>
|
||||
<procedure>
|
||||
<step>
|
||||
<para>Perform any needed repocopies.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Update the <makevar>VALID_CATEGORIES</makevar>
|
||||
definition in <filename>ports/Mk/bsd.port.mk</filename>.
|
||||
</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Assign the PR back to you.</para>
|
||||
</step>
|
||||
</procedure>
|
||||
</answer>
|
||||
</qandaentry>
|
||||
|
||||
|
|
@ -2688,18 +2701,6 @@ docs:Documentation Bug:freebsd-doc:</programlisting>
|
|||
<para>The procedure is a strict superset of the one to
|
||||
repocopy individual ports (see above).</para>
|
||||
|
||||
<para>File a PR in <application>GNATS</application>, listing the
|
||||
reasons for the category request. Preferably, this should
|
||||
also include patches for <filename>Makefile</filename>s for
|
||||
the old ports, the <filename>Makefile</filename>s for their
|
||||
old categories, and the <makevar>VALID_CATEGORIES</makevar>
|
||||
definition in <filename>ports/Mk/bsd.port.mk</filename>.
|
||||
Assign the PR to the &a.portmgr; (as <literal>portmgr</literal>).
|
||||
If they approve it, it will be reassigned to &a.cvsadm; (as
|
||||
<literal>cvs</literal>), who will do a repository copy from
|
||||
the old to the new locations and reassign the PR back to you.
|
||||
Once everything is done, perform the following steps:</para>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
<para>Upgrade each copied port's
|
||||
|
|
@ -2797,14 +2798,41 @@ docs:Documentation Bug:freebsd-doc:</programlisting>
|
|||
<filename>cvsup/sup/ports-categoryname</filename>:
|
||||
<filename>list.cvs</filename> and
|
||||
<filename>releases</filename>. (Note: these are
|
||||
in the src, not the ports, repository).</para>
|
||||
in the src, not the ports, repository). If you
|
||||
are not a src committer, you will need to submit
|
||||
a PR for this.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Submit a docs PR to add the new category to both the
|
||||
<para>Update the documentation by modifying the
|
||||
following:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>the
|
||||
<ulink url="&url.books.porters-handbook;/makefile-categories.html#PORTING-CATEGORIES">
|
||||
Porter's Handbook</ulink> and to
|
||||
<filename>www/en/ports/categories</filename>.</para>
|
||||
list of categories</ulink> in the Porter's Handbook</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
<filename>www/en/ports/categories</filename>.
|
||||
Note that these are now displayed by sub-groups,
|
||||
as specified in
|
||||
<filename>www/en/ports/categories.descriptions</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>the section of the Handbook that lists the
|
||||
<ulink url="&url.books.handbook;/cvsup.html#CVSUP-COLLEC">
|
||||
cvsup collections</ulink>.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>(Note: these are
|
||||
in the docs, not the ports, repository). If you
|
||||
are not a docs committer, you will need to submit
|
||||
a PR for this.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
|
|
|
|||
Loading…
Reference in a new issue