docs/96639: [patch] suggestion to committer's guide that should have a description about remove ports

[Vasil Dimov]

The following reply was made to PR docs/96639; it has been noted by GNATS.

From: Vasil Dimov <vd at FreeBSD.org>
To: Cheng-Lung Sung <clsung at FreeBSD.org>
Cc: bug-followup at FreeBSD.org, erwin at FreeBSD.org
Subject: Re: docs/96639: [patch] suggestion to committer's guide that should have a description about remove ports
Date: Thu, 4 May 2006 11:09:33 +0300

 On Thu, May 04, 2006 at 03:29:17PM +0800, Cheng-Lung Sung wrote:
 > Hi, 
 >     Thank to your suggestions.
 > 
 >     I made some modification, and the patch now is placed at
 > 
 >     http://people.freebsd.org/~clsung/patch-committers-guide_v2
 > 
 >     If you are free can you help me review that?
 > 
 Looks fine, here is a slightly modified version:
 
 --- patch-committers-guide_v2 begins here ---
 --- article.sgml.orig	Thu Apr 20 09:49:55 2006
 +++ article.sgml	Thu May  4 15:22:53 2006
 @@ -2423,6 +2423,74 @@
        </qandadiv>
 
        <qandadiv>
 +	<title>Removing an Existing Port</title>
 +
 +	<qandaentry>
 +	  <question>
 +	    <para>How do I remove an existing port?</para>
 +	  </question>
 +
 +	  <answer>
 +	    <para>First, please read the section about repository
 +	      copies. Before you remove the port, you have to verify
 +	      there are no other ports depending on it.</para>
 +	    <itemizedlist>
 +              <listitem>
 +	        <para>Make sure there is no dependency on the port
 +	          in the ports collection:</para>
 +	          <itemizedlist>
 +	            <listitem>
 +	              <para>The port's PKGNAME should appear in exactly one
 +	                line in a recent INDEX file.</para>
 +	            </listitem>
 +	            <listitem>
 +	              <para>No other ports should contain any reference to
 +	                the port's directory or PKGNAME in their
 +	                Makefiles</para>
 +	            </listitem>
 +	      </itemizedlist>
 +              </listitem>
 +              <listitem>
 +	        <para>Then, remove the port:</para>
 +
 +	        <procedure>
 +	          <step>
 +	            <para>Remove the port's files via <command>cvs remove</command>.</para>
 +	          </step>
 +
 +	          <step>
 +	            <para>Remove <makevar>SUBDIR</makevar> listing of the port
 +	              in the parent directory <filename>Makefile</filename>.</para>
 +	          </step>
 +
 +	          <step>
 +	            <para>Remove the module entry in
 +	              <filename>CVSROOT/modules</filename>.</para>
 +	          </step>
 +
 +	          <step>
 +	            <para>Add an entry to
 +	              <filename>ports/MOVED</filename>.</para>
 +	          </step>
 +
 +	          <step>
 +	            <para>Remove the port from
 +	              <filename>ports/LEGAL</filename> if it is there.</para>
 +	          </step>
 +	        </procedure>
 +	      </listitem>
 +	    </itemizedlist>
 +	    <para>However, there is a
 +	      <command>ports/Tools/scripts/rmport</command> script
 +	      that automates all the necessary steps for removing a port.
 +	      It was written by &a.vd;, who is also the current maintainer
 +	      so please send questions/patches about
 +	      <command>rmport</command> to him.</para>
 +	  </answer>
 +	</qandaentry>
 +      </qandadiv>
 +
 +      <qandadiv>
  	<title>Repository Copies</title>
 
  	<qandaentry>
 @@ -2495,9 +2563,9 @@
  		  <step>
  		    <para>Add the new subdirectory to the
  		      <makevar>SUBDIR</makevar> listing in the parent
 -		      directory Makefile.  You can run <command>make
 -		      checksubdirs</command> in the parent directory to check
 -		      this.</para>
 +		      directory <filename>Makefile</filename>.  You can run
 +		      <command>make checksubdirs</command> in the parent
 +		      directory to check this.</para>
  		  </step>
 
  		  <step>
 --- patch-committers-guide_v2 ends here ---
 
 -- 
 Vasil Dimov
 gro.DSBeerF at dv
 
 Testing can show the presence of bugs, but not their absence.
                 -- Edsger W. Dijkstra