Annotation of htdocs/docs/pkgsrc/submit.html, revision 1.14
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1.4 rillig 5: <title>Chapter 21. Submitting and Committing</title>
1.11 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.6 rillig 8: <link rel="home" href="index.html" title="The pkgsrc guide">
1.1 dsieger 9: <link rel="up" href="developers-guide.html" title="Part II. The pkgsrc developer's guide">
1.4 rillig 10: <link rel="prev" href="debug.html" title="Chapter 20. Debugging">
11: <link rel="next" href="devfaq.html" title="Chapter 22. Frequently Asked Questions">
1.1 dsieger 12: </head>
13: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14: <div class="navheader">
15: <table width="100%" summary="Navigation header">
1.4 rillig 16: <tr><th colspan="3" align="center">Chapter 21. Submitting and Committing</th></tr>
1.1 dsieger 17: <tr>
18: <td width="20%" align="left">
19: <a accesskey="p" href="debug.html">Prev</a> </td>
20: <th width="60%" align="center">Part II. The pkgsrc developer's guide</th>
21: <td width="20%" align="right"> <a accesskey="n" href="devfaq.html">Next</a>
22: </td>
23: </tr>
24: </table>
25: <hr>
26: </div>
1.10 wiz 27: <div class="chapter" title="Chapter 21. Submitting and Committing">
1.1 dsieger 28: <div class="titlepage"><div><div><h2 class="title">
1.4 rillig 29: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 30: <div class="toc">
31: <p><b>Table of Contents</b></p>
32: <dl>
1.4 rillig 33: <dt><span class="sect1"><a href="submit.html#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
34: <dt><span class="sect1"><a href="submit.html#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
35: <dt><span class="sect1"><a href="submit.html#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.13 wiz 36: <dt><span class="sect1"><a href="submit.html#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.4 rillig 37: <dt><span class="sect1"><a href="submit.html#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.7 snj 38: <dt><span class="sect1"><a href="submit.html#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
39: <dt><span class="sect1"><a href="submit.html#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 40: </dl>
41: </div>
1.10 wiz 42: <div class="sect1" title="21.1. Submitting binary packages">
1.1 dsieger 43: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 44: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 45: <p>Our policy is that we accept binaries only from pkgsrc
46: developers to guarantee that the packages don't contain any
47: trojan horses etc. This is not to annoy anyone but rather to
48: protect our users! You're still free to put up your home-made
49: binary packages and tell the world where to get them. NetBSD
50: developers doing bulk builds and wanting to upload them please
1.5 hubertf 51: see <a class="xref" href="bulk.html#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, “Uploading results of a bulk build”</a>.</p>
1.1 dsieger 52: </div>
1.10 wiz 53: <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
1.1 dsieger 54: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 55: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 56: <p>First, check that your package is complete, compiles and
1.5 hubertf 57: runs well; see <a class="xref" href="debug.html" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.12 dholland 58: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 59: archive that contains all files that make up the package.
60: Finally, send this package to the pkgsrc bug tracking system,
1.12 dholland 61: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 62: that, go to the web page
1.5 hubertf 63: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.8 snj 64: which contains some instructions and a link to a form where you
65: can submit packages. The
66: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
67: also available as a substitute for either of the above two tools.
68: </p>
1.1 dsieger 69: <p>In the form of the problem report, the category should be
1.10 wiz 70: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 71: and version number, and the description field should contain a
72: short description of your package (contents of the COMMENT
73: variable or DESCR file are OK). The uuencoded package data should
1.10 wiz 74: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 75: <p>If you want to submit several packages, please send a
76: separate PR for each one, it's easier for us to track things
77: that way.</p>
78: <p>Alternatively, you can also import new packages into
1.10 wiz 79: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.5 hubertf 80: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 81: for details.</p>
82: </div>
1.10 wiz 83: <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
1.1 dsieger 84: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 85: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 86: <p>Please note all package additions, updates, moves, and
87: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
88: important to keep this file up to date and conforming to the
89: existing format, because it will be used by scripts to
1.5 hubertf 90: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 91: sites. Additionally, check the
92: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
93: for the package you updated or removed, in case it was mentioned
94: there.</p>
95: <p>When the <code class="varname">PKGREVISION</code> of a package is
96: bumped, the change should appear in
97: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
98: related or otherwise relevant. Mass bumps that result from a
99: dependency being updated should not be mentioned. In all other
100: cases it's the developer's decision.</p>
101: <p>There is a make target that helps in creating proper
1.5 hubertf 102: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 103: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
104: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
105: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
106: file is up-to-date (to avoid having to resolve conflicts later-on)
1.5 hubertf 107: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
108: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 109: For new packages, or package moves or removals, set the
110: <code class="varname">CTYPE</code> variable on the command line to "Added",
111: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.5 hubertf 112: in <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.9 jakllsch 113: not the same as your NetBSD login name. The target also automatically
114: removes possibly existing entries for the package in the
115: <code class="filename">TODO</code> file. Don't forget to commit
116: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
117: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
118: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
119: makes the cvs commands use the main repository.
120: </p>
1.1 dsieger 121: </div>
1.13 wiz 122: <div class="sect1" title="21.4. Committing: Adding a package to CVS">
1.1 dsieger 123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.13 wiz 124: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 125: <p>This section is only of interest for pkgsrc developers with write
1.13 wiz 126: access to the pkgsrc repository.</p>
127: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
128: Start by adding the directory and then files in the directory. Don't
129: forget to add the new package to the category's
130: <code class="filename">Makefile</code>. Make sure you don't forget any files;
131: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
1.1 dsieger 132: <pre class="programlisting">
1.13 wiz 133: <code class="prompt">$</code> cd .../pkgsrc/category
134: <code class="prompt">$</code> cvs add pkgname
135: <code class="prompt">$</code> cd pkgname
136: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
137: <code class="prompt">$</code> cvs add patches/p*
138: <code class="prompt">$</code> cvs status | less
1.14 ! wiz 139: <code class="prompt">$</code> cvs commit
1.13 wiz 140: <code class="prompt">$</code> cd ..
141: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.14 ! wiz 142: <code class="prompt">$</code> cvs commit Makefile
1.1 dsieger 143: </pre>
144: <p>The commit message of the initial import should include part of the
145: <code class="filename">DESCR</code> file, so people reading the mailing lists know
146: what the package is/does.</p>
1.13 wiz 147: <p>Also mention the new package in
148: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
149: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
150: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 151: </div>
1.10 wiz 152: <div class="sect1" title="21.5. Updating a package to a newer version">
1.1 dsieger 153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 154: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 155: <p>Please always put a concise, appropriate and relevant summary of the
156: changes between old and new versions into the commit log when updating
157: a package. There are various reasons for this:</p>
1.10 wiz 158: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
159: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 160: or its information may be overwritten by newer information.</p></li>
1.10 wiz 161: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 162: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.10 wiz 163: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 164: repository is very useful for people who read the pkgsrc-changes mailing
165: list, so that they can make tactical decisions about when to upgrade
166: the package.</p></li>
167: </ul></div>
168: <p>Please also recognize that, just because a new version of a package
169: has been released, it should not automatically be upgraded in the CVS
170: repository. We prefer to be conservative in the packages that are
171: included in pkgsrc - development or beta packages are not really the
172: best thing for most places in which pkgsrc is used. Please use your
173: judgement about what should go into pkgsrc, and bear in mind that
174: stability is to be preferred above new and possibly untested features.</p>
175: </div>
1.10 wiz 176: <div class="sect1" title="21.6. Renaming a package in pkgsrc">
1.1 dsieger 177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.7 snj 178: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
179: <p>Renaming packages is not recommended.</p>
180: <p>When renaming packages, be sure to fix any references to old name
181: in other Makefiles, options, buildlink files, etc.</p>
182: <p>Also When renaming a package, please define
183: <code class="varname">SUPERSEDES</code> to the package name and dewey version
184: pattern(s) of the previous package name.
185: This may be repeated for multiple renames.
186: The new package would be an exact replacement.
187: </p>
1.10 wiz 188: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.7 snj 189: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
190: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
191: not be an exact replacement but is a suggestion for the replaced
192: functionality.</p>
193: </div>
1.10 wiz 194: <div class="sect1" title="21.7. Moving a package in pkgsrc">
1.7 snj 195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
196: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
197: <p>It is preferred that packages are not renamed or moved, but if needed
198: please follow these steps.
199: </p>
1.10 wiz 200: <div class="orderedlist"><ol class="orderedlist" type="1">
201: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
202: <li class="listitem">
1.1 dsieger 203: <p>Remove all CVS dirs.</p>
204: <p>Alternatively to the first two steps you can also do:</p>
205: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
206: <p>and use that for further work.</p>
207: </li>
1.10 wiz 208: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
209: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
210: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
211: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.7 snj 212: <code class="varname">PREV_PKGPATH</code> to the previous category/package
213: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
214: for doing an update using pkgsrc building; for example, it can
1.12 dholland 215: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.7 snj 216: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
217: new <code class="varname">PKGPATH</code> for that moved package. Note that
218: it may have multiple matches, so the tool should also check on the
219: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
220: probably has no value unless <code class="varname">SUPERSEDES</code> is not
221: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.10 wiz 222: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 223: place.</p></li>
1.10 wiz 224: <li class="listitem">
1.1 dsieger 225: <p>Check if any package depends on it:
226: </p>
227: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
228: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
229: </li>
1.10 wiz 230: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
231: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
232: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
233: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
234: <li class="listitem">
1.1 dsieger 235: <p>Commit the changed and removed files:</p>
236: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
237: <p>(and any packages from step 5, of course).</p>
238: </li>
239: </ol></div>
240: </div>
241: </div>
242: <div class="navfooter">
243: <hr>
244: <table width="100%" summary="Navigation footer">
245: <tr>
246: <td width="40%" align="left">
247: <a accesskey="p" href="debug.html">Prev</a> </td>
248: <td width="20%" align="center"><a accesskey="u" href="developers-guide.html">Up</a></td>
249: <td width="40%" align="right"> <a accesskey="n" href="devfaq.html">Next</a>
250: </td>
251: </tr>
252: <tr>
1.4 rillig 253: <td width="40%" align="left" valign="top">Chapter 20. Debugging </td>
1.1 dsieger 254: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.4 rillig 255: <td width="40%" align="right" valign="top"> Chapter 22. Frequently Asked Questions</td>
1.1 dsieger 256: </tr>
257: </table>
258: </div>
259: </body>
260: </html>
CVSweb <webmaster@jp.NetBSD.org>