svn commit: r39204 - head/en_US.ISO8859-1/books/porters-handbook

[Isabell Long]

Author: issyl0
Date: Sat Jul 14 16:32:27 2012
New Revision: 39204
URL: http://svn.freebsd.org/changeset/doc/39204

Log:
  Add more information to the section of the porter's handbook about the
  MOVED file.
  
  Submitted by:	issyl0 (as part of Google Code-In 2011)
  Reviewed by:	gavin, gjb
  Approved by:	gabor (mentor)

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/book.sgml

Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/book.sgml	Sat Jul 14 15:25:52 2012	(r39203)
+++ head/en_US.ISO8859-1/books/porters-handbook/book.sgml	Sat Jul 14 16:32:27 2012	(r39204)
@@ -10419,12 +10419,24 @@ as .putsy.conf and edit it.</programlist
 	instructions, please make sure to get the shell escaping
 	right.</para>
 
-      <para>If your port is deleted or renamed, you should add an
-	entry to <filename>/usr/ports/MOVED</filename>.  Entries in
-	this file use the following format:</para>
+      <para>The <filename>/usr/ports/MOVED</filename> file is used to
+	list moved or removed ports.  Each line in the file is made
+	up of the name of the port, where the port was moved to, when,
+	and why.  If the port was removed, the section detailing where
+	it was moved to can be left blank.  Each section must be
+	separated by the <literal>|</literal> (pipe) character, like
+	so:</para>
 
       <programlisting>old name|new name (blank for deleted)|date of move|reason</programlisting>
 
+      <para>The date should be entered in the form <literal>YYYY-
+	MM-DD</literal>.  New entries should be added to the end
+	of the file to keep it in chronological order.</para>
+
+      <para>If a port was removed but has since been restored,
+	delete the line in this file that states that it was
+	removed.</para>
+
       <para>The changes can be validated with
 	<command>Tools/scripts/MOVEDlint.awk</command>.</para>
     </sect1>