docs/152462: [patch] document UPDATIN and MOVED in the porters handbook

Eitan Adler lists at eitanadler.com
Sun Nov 21 22:40:12 UTC 2010


>Number:         152462
>Category:       docs
>Synopsis:       [patch] document UPDATIN and MOVED in the porters handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sun Nov 21 22:40:11 UTC 2010
>Closed-Date:
>Last-Modified:
>Originator:     Eitan Adler
>Release:        
>Organization:
>Environment:
>Description:
The files UPDATING and MOVED are not currently documented.
>How-To-Repeat:

>Fix:
Index: book.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v
retrieving revision 1.1081
diff -u -r1.1081 book.sgml
--- book.sgml	20 Nov 2010 13:45:33 -0000	1.1081
+++ book.sgml	21 Nov 2010 22:20:50 -0000
@@ -9404,7 +9404,23 @@
 
       <para>Now that you have done all that, you will want to read about
 	how to keep up-to-date in <xref linkend="keeping-up">.</para>
-
+	<sect1 id="moved-and-updating-files">
+         <title>UPDATING and MOVED</title>
+         <para>If upgrading the port requires a special process such as changing configuration files or 
+              running a specific program you should document it in <filename>UPDATING</filename>
+              The format of <filename>UPDATING</filename> is 
+		  <programlisting>YYYYMMDD:
+  AFFECTS: users of portcategory/portname
+  AUTHOR: Your name <Your email address>
+
+  Special instructions</programlisting>
+              If you are including exact portmaster or portupgrading instructions please make sure to get the shell escaping correct.
+        </para>
+        <para>
+          If your port is deleted or changes names you should add an entry to <filename>MOVED</filename>.
+          The format for an entry is:<programlisting>old name|new name (blank for deleted)|date of move|reason</programlisting>
+        </para>
+	</sect1>
     </chapter>
 
     <chapter id="security">

>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list