PR: docs/152462

Document purpose/format of /usr/ports/UPDATING and /usr/ports/MOVED.

Based on a patch provided by:   Eitan Adler (lists att eitanadler dott com)
This commit is contained in:
Johann Kois 2010-11-22 19:15:29 +00:00
parent c2775f46b8
commit 126251a1ce
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=36624

View file

@ -9411,6 +9411,31 @@ as .putsy.conf and edit it.</programlisting>
<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>The files UPDATING and MOVED</title>
<para>If upgrading the port requires special steps like
changing configuration files or running a specific program,
you should document this in the file
<filename>/usr/ports/UPDATING</filename>. The format of
an entry in this file is as follows:</para>
<programlisting>YYYYMMDD:
AFFECTS: users of portcategory/portname
AUTHOR: Your name &lt;Your email address&gt;
Special instructions</programlisting>
<para>If you are including exact portmaster or portupgrading
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>
<programlisting>old name|new name (blank for deleted)|date of move|reason</programlisting>
</sect1>
</chapter>
<chapter id="security">