[pkgsrc/trunk]: pkgsrc/doc/guide/files Add a new section describing what to d...

[wiz <wiz%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/c32b0be99bc4
branches:  trunk
changeset: 495414:c32b0be99bc4
user:      wiz <wiz%pkgsrc.org@localhost>
date:      Wed Jun 08 23:03:49 2005 +0000

description:
Add a new section describing what to do when changing packages.
(points to pkgsrc/doc/CHANGES and pkgsrc/doc/TODO, and describes
the changes-entry target).

diffstat:

 doc/guide/files/submit.xml |  40 +++++++++++++++++++++++++++++-----------
 1 files changed, 29 insertions(+), 11 deletions(-)

diffs (61 lines):

diff -r aa92aecec743 -r c32b0be99bc4 doc/guide/files/submit.xml
--- a/doc/guide/files/submit.xml        Wed Jun 08 22:46:26 2005 +0000
+++ b/doc/guide/files/submit.xml        Wed Jun 08 23:03:49 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: submit.xml,v 1.6 2005/05/24 12:14:42 wiz Exp $ -->
+<!-- $NetBSD: submit.xml,v 1.7 2005/06/08 23:03:49 wiz Exp $ -->
 
 <chapter id="submit"> <?dbhtml filename="submit.html"?>
 <title>Submitting and Committing</title>
@@ -51,6 +51,34 @@
 
 </sect1>
 
+<sect1 id="general-notes-for-changes">
+<title>General notes when adding, updating, or removing packages</title>
+<para>Please note all package additions, updates, moves, and removals
+  in <filename>pkgsrc/doc/CHANGES</filename>. It's very important
+  to keep this file up to date and conforming to the existing
+  format, because it will be used by scripts to automatically update
+  pages on <ulink url="http://www.NetBSD.org/";>www.NetBSD.org</ulink>
+  and other sites. Additionally, check the
+  <filename>pkgsrc/doc/TODO</filename> file and remove the entry
+  for the package you updated or removed, in case it was mentioned
+  there.</para>
+
+<para>There is a make target that helps in creating proper
+  <filename>CHANGES</filename> entries:  <command>make
+  changes-entry</command>. It uses the optional <varname>CTYPE</varname>
+  and <varname>NETBSD_LOGIN_NAME</varname> variables. The general
+  usage is to first make sure that your <filename>CHANGES</filename>
+  file is up-to-date (to avoid having to resolve conflicts later-on)
+  and then to <command>cd</command> to the package directory.  For
+  package updates, <command>make changes-entry</command> is enough.
+  For new packages, or package moves or removals, set the
+  <varname>CTYPE</varname> variable on the command line to "Added",
+  "Moved", or "Removed".  You can set <varname>NETBSD_LOGIN_NAME</varname>
+  in <filename>/etc/mk.conf</filename> if your local login name is
+  not the same as your NetBSD login name. Don't forget to commit
+  the changes to <filename>pkgsrc/doc/CHANGES</filename>!</para>
+</sect1>
+
 <sect1 id="committing-importing">
 <title>Committing: Importing a package into CVS</title>
 <para>
@@ -83,16 +111,6 @@
 </para>
 
 <para>
-  Please note all package updates/additions in
-  <filename>pkgsrc/doc/CHANGES</filename>. It's very
-  important to keep this file up to date and conforming to the existing
-  format, because it will be used by scripts to automatically update pages on
-  <ulink url="http://www.NetBSD.org/";>www.NetBSD.org</ulink> and other
-  sites. Additionally, check the pkgsrc/doc/TODO file and remove the entry
-  for the package you updated, in case it was mentioned there.
-</para>
-
-<para>
   For new packages, <quote>cvs import</quote> is preferred to <quote>cvs
   add</quote> because the former gets everything with a single command,
   and provides a consistent tag.