pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc regen (new section on what to do when changing pac...
details: https://anonhg.NetBSD.org/pkgsrc/rev/4b9ce7aa1e82
branches: trunk
changeset: 495415:4b9ce7aa1e82
user: wiz <wiz%pkgsrc.org@localhost>
date: Wed Jun 08 23:04:15 2005 +0000
description:
regen (new section on what to do when changing packages)
diffstat:
doc/pkgsrc.html | 96 +++++++++++++++++++++++++++++++++++++++++++-------------
doc/pkgsrc.txt | 53 ++++++++++++++++++++-----------
2 files changed, 108 insertions(+), 41 deletions(-)
diffs (267 lines):
diff -r c32b0be99bc4 -r 4b9ce7aa1e82 doc/pkgsrc.html
--- a/doc/pkgsrc.html Wed Jun 08 23:03:49 2005 +0000
+++ b/doc/pkgsrc.html Wed Jun 08 23:04:15 2005 +0000
@@ -862,15 +862,20 @@
packages</a></span></dt>
<dt><span class="sect1"><a href=
- "#committing-importing">17.2. Committing: Importing
+ "#general-notes-for-changes">17.2. General notes
+ when adding, updating, or removing
+ packages</a></span></dt>
+
+ <dt><span class="sect1"><a href=
+ "#committing-importing">17.3. Committing: Importing
a package into CVS</a></span></dt>
<dt><span class="sect1"><a href=
- "#updating-package">17.3. Updating a package to a
+ "#updating-package">17.4. Updating a package to a
newer version</a></span></dt>
<dt><span class="sect1"><a href=
- "#moving-package">17.4. Moving a package in
+ "#moving-package">17.5. Moving a package in
pkgsrc</a></span></dt>
</dl>
</dd>
@@ -5520,15 +5525,20 @@
packages</a></span></dt>
<dt><span class="sect1"><a href=
- "#committing-importing">17.2. Committing: Importing a
+ "#general-notes-for-changes">17.2. General notes when
+ adding, updating, or removing
+ packages</a></span></dt>
+
+ <dt><span class="sect1"><a href=
+ "#committing-importing">17.3. Committing: Importing a
package into CVS</a></span></dt>
<dt><span class="sect1"><a href=
- "#updating-package">17.3. Updating a package to a
+ "#updating-package">17.4. Updating a package to a
newer version</a></span></dt>
<dt><span class="sect1"><a href=
- "#moving-package">17.4. Moving a package in
+ "#moving-package">17.5. Moving a package in
pkgsrc</a></span></dt>
</dl>
</dd>
@@ -12329,14 +12339,18 @@
packages</a></span></dt>
<dt><span class="sect1"><a href=
- "#committing-importing">17.2. Committing: Importing a
+ "#general-notes-for-changes">17.2. General notes when
+ adding, updating, or removing packages</a></span></dt>
+
+ <dt><span class="sect1"><a href=
+ "#committing-importing">17.3. Committing: Importing a
package into CVS</a></span></dt>
<dt><span class="sect1"><a href=
- "#updating-package">17.3. Updating a package to a newer
+ "#updating-package">17.4. Updating a package to a newer
version</a></span></dt>
- <dt><span class="sect1"><a href="#moving-package">17.4.
+ <dt><span class="sect1"><a href="#moving-package">17.5.
Moving a package in pkgsrc</a></span></dt>
</dl>
</div>
@@ -12416,8 +12430,56 @@
<div>
<div>
<h2 class="title" style="clear: both"><a name=
+ "general-notes-for-changes" id=
+ "general-notes-for-changes"></a>17.2. General
+ notes when adding, updating, or removing
+ packages</h2>
+ </div>
+ </div>
+ </div>
+
+ <p>Please note all package additions, updates, moves, and
+ removals in <code class=
+ "filename">pkgsrc/doc/CHANGES</code>. 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 <a href=
+ "http://www.NetBSD.org/"; target="_top">www.NetBSD.org</a>
+ and other sites. Additionally, check the <code class=
+ "filename">pkgsrc/doc/TODO</code> file and remove the
+ entry for the package you updated or removed, in case it
+ was mentioned there.</p>
+
+ <p>There is a make target that helps in creating proper
+ <code class="filename">CHANGES</code> entries:
+ <span><strong class="command">make
+ changes-entry</strong></span>. It uses the optional
+ <code class="varname">CTYPE</code> and <code class=
+ "varname">NETBSD_LOGIN_NAME</code> variables. The general
+ usage is to first make sure that your <code class=
+ "filename">CHANGES</code> file is up-to-date (to avoid
+ having to resolve conflicts later-on) and then to
+ <span><strong class="command">cd</strong></span> to the
+ package directory. For package updates,
+ <span><strong class="command">make
+ changes-entry</strong></span> is enough. For new
+ packages, or package moves or removals, set the
+ <code class="varname">CTYPE</code> variable on the
+ command line to "Added", "Moved", or "Removed". You can
+ set <code class="varname">NETBSD_LOGIN_NAME</code> in
+ <code class="filename">/etc/mk.conf</code> if your local
+ login name is not the same as your NetBSD login name.
+ Don't forget to commit the changes to <code class=
+ "filename">pkgsrc/doc/CHANGES</code>!</p>
+ </div>
+
+ <div class="sect1" lang="en" xml:lang="en">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title" style="clear: both"><a name=
"committing-importing" id=
- "committing-importing"></a>17.2. Committing:
+ "committing-importing"></a>17.3. Committing:
Importing a package into CVS</h2>
</div>
</div>
@@ -12451,16 +12513,6 @@
file, so people reading the mailing lists know what the
package is/does.</p>
- <p>Please note all package updates/additions in
- <code class="filename">pkgsrc/doc/CHANGES</code>. 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 <a href=
- "http://www.NetBSD.org/"; target="_top">www.NetBSD.org</a>
- 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.</p>
-
<p>For new packages, “<span class="quote">cvs
import</span>” is preferred to “<span class=
"quote">cvs add</span>” because the former gets
@@ -12474,7 +12526,7 @@
<div>
<h2 class="title" style="clear: both"><a name=
"updating-package" id=
- "updating-package"></a>17.3. Updating a
+ "updating-package"></a>17.4. Updating a
package to a newer version</h2>
</div>
</div>
@@ -12526,7 +12578,7 @@
<div>
<h2 class="title" style="clear: both"><a name=
"moving-package" id=
- "moving-package"></a>17.4. Moving a package in
+ "moving-package"></a>17.5. Moving a package in
pkgsrc</h2>
</div>
</div>
diff -r c32b0be99bc4 -r 4b9ce7aa1e82 doc/pkgsrc.txt
--- a/doc/pkgsrc.txt Wed Jun 08 23:03:49 2005 +0000
+++ b/doc/pkgsrc.txt Wed Jun 08 23:04:15 2005 +0000
@@ -252,9 +252,10 @@
17. Submitting and Committing
17.1. Submitting your packages
- 17.2. Committing: Importing a package into CVS
- 17.3. Updating a package to a newer version
- 17.4. Moving a package in pkgsrc
+ 17.2. General notes when adding, updating, or removing packages
+ 17.3. Committing: Importing a package into CVS
+ 17.4. Updating a package to a newer version
+ 17.5. Moving a package in pkgsrc
A. A simple example package: bison
@@ -2086,9 +2087,10 @@
17. Submitting and Committing
17.1. Submitting your packages
- 17.2. Committing: Importing a package into CVS
- 17.3. Updating a package to a newer version
- 17.4. Moving a package in pkgsrc
+ 17.2. General notes when adding, updating, or removing packages
+ 17.3. Committing: Importing a package into CVS
+ 17.4. Updating a package to a newer version
+ 17.5. Moving a package in pkgsrc
Chapter 8. Package components - files, directories and contents
@@ -5007,9 +5009,10 @@
Table of Contents
17.1. Submitting your packages
-17.2. Committing: Importing a package into CVS
-17.3. Updating a package to a newer version
-17.4. Moving a package in pkgsrc
+17.2. General notes when adding, updating, or removing packages
+17.3. Committing: Importing a package into CVS
+17.4. Updating a package to a newer version
+17.5. Moving a package in pkgsrc
17.1. Submitting your packages
@@ -5041,7 +5044,26 @@
work-in-progress"); see the homepage at http://pkgsrc-wip.sourceforge.net/
for details.
-17.2. Committing: Importing a package into CVS
+17.2. General notes when adding, updating, or removing packages
+
+Please note all package additions, updates, moves, and removals in pkgsrc/doc/
+CHANGES. 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 www.NetBSD.org and other sites. Additionally, check the pkgsrc/doc/
+TODO file and remove the entry for the package you updated or removed, in case
+it was mentioned there.
+
+There is a make target that helps in creating proper CHANGES entries: make
+changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
+general usage is to first make sure that your CHANGES file is up-to-date (to
+avoid having to resolve conflicts later-on) and then to cd to the package
+directory. For package updates, make changes-entry is enough. For new packages,
+or package moves or removals, set the CTYPE variable on the command line to
+"Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in /etc/mk.conf
+if your local login name is not the same as your NetBSD login name. Don't
+forget to commit the changes to pkgsrc/doc/CHANGES!
+
+17.3. Committing: Importing a package into CVS
This section is only of interest for pkgsrc developers with write access to the
pkgsrc repository. Please remember that cvs imports files relative to the
@@ -5060,17 +5082,10 @@
The commit message of the initial import should include part of the DESCR file,
so people reading the mailing lists know what the package is/does.
-Please note all package updates/additions in pkgsrc/doc/CHANGES. 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
-www.NetBSD.org 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.
-
For new packages, "cvs import" is preferred to "cvs add" because the former
gets everything with a single command, and provides a consistent tag.
-17.3. Updating a package to a newer version
+17.4. Updating a package to a newer version
Please always put a concise, appropriate and relevant summary of the changes
between old and new versions into the commit log when updating a package. There
@@ -5095,7 +5110,7 @@
pkgsrc, and bear in mind that stability is to be preferred above new and
possibly untested features.
-17.4. Moving a package in pkgsrc
+17.5. Moving a package in pkgsrc
1. Make a copy of the directory somewhere else.
Home |
Main Index |
Thread Index |
Old Index