Annotation of htdocs/docs/pkgsrc/submit.html, revision 1.7

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.2       rillig      6: <link rel="stylesheet" href="/global.css" type="text/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>
                     27: <div class="chapter" lang="en">
                     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>
                     36: <dt><span class="sect1"><a href="submit.html#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                     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>
                     42: <div class="sect1" lang="en">
                     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, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
1.1       dsieger    52: </div>
                     53: <div class="sect1" lang="en">
                     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
                     58:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><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.5       hubertf    61:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><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.1       dsieger    64:        which contains some instructions and a link to a form, where you
                     65:        can submit packages.</p>
                     66: <p>In the form of the problem report, the category should be
                     67:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                     68:        and version number, and the description field should contain a
                     69:        short description of your package (contents of the COMMENT
                     70:        variable or DESCR file are OK). The uuencoded package data should
                     71:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
                     72: <p>If you want to submit several packages, please send a
                     73:        separate PR for each one, it's easier for us to track things
                     74:        that way.</p>
                     75: <p>Alternatively, you can also import new packages into
                     76:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
1.5       hubertf    77:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1       dsieger    78:        for details.</p>
                     79: </div>
                     80: <div class="sect1" lang="en">
                     81: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig     82: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger    83: <p>Please note all package additions, updates, moves, and
                     84:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                     85:        important to keep this file up to date and conforming to the
                     86:        existing format, because it will be used by scripts to
1.5       hubertf    87:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger    88:        sites. Additionally, check the
                     89:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                     90:        for the package you updated or removed, in case it was mentioned
                     91:        there.</p>
                     92: <p>When the <code class="varname">PKGREVISION</code> of a package is
                     93:        bumped, the change should appear in
                     94:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                     95:        related or otherwise relevant. Mass bumps that result from a
                     96:        dependency being updated should not be mentioned. In all other
                     97:        cases it's the developer's decision.</p>
                     98: <p>There is a make target that helps in creating proper
1.5       hubertf    99:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger   100:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                    101:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                    102:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                    103:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.5       hubertf   104:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                    105:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger   106:   For new packages, or package moves or removals, set the
                    107:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                    108:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.5       hubertf   109:   in <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.1       dsieger   110:   not the same as your NetBSD login name. Don't forget to commit
                    111:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
                    112: </div>
                    113: <div class="sect1" lang="en">
                    114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig    115: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1       dsieger   116: <p>This section is only of interest for pkgsrc developers with write
                    117:   access to the pkgsrc repository. Please remember that cvs
                    118:   imports files relative to the current working directory, and that
                    119:   the pathname that you
1.5       hubertf   120:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.1       dsieger   121:   to place the files in the repository.  Newly created packages should be
                    122:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
                    123:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
                    124: <pre class="programlisting">
                    125: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                    126: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
                    127: </pre>
                    128: <p>Remember to move the directory from which you imported out of
                    129:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                    130:   update</span>&#8221; your source tree.  Also don't forget to add the new
                    131:   package to the category's <code class="filename">Makefile</code>.</p>
                    132: <p>The commit message of the initial import should include part of the
                    133:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                    134:   what the package is/does.</p>
                    135: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
                    136:   add</span>&#8221; because the former gets everything with a single command,
                    137:   and provides a consistent tag.</p>
                    138: </div>
                    139: <div class="sect1" lang="en">
                    140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig    141: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger   142: <p>Please always put a concise, appropriate and relevant summary of the
                    143:   changes between old and new versions into the commit log when updating
                    144:   a package. There are various reasons for this:</p>
                    145: <div class="itemizedlist"><ul type="disc">
                    146: <li><p>A URL is volatile, and can change over time. It may go away completely
                    147:   or its information may be overwritten by newer information.</p></li>
                    148: <li><p>Having the change information between old and new versions in our CVS
                    149:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                    150: <li><p>Having the change information between old and new versions in our CVS
                    151:   repository is very useful for people who read the pkgsrc-changes mailing
                    152:   list, so that they can make tactical decisions about when to upgrade
                    153:   the package.</p></li>
                    154: </ul></div>
                    155: <p>Please also recognize that, just because a new version of a package
                    156:   has been released, it should not automatically be upgraded in the CVS
                    157:   repository.  We prefer to be conservative in the packages that are
                    158:   included in pkgsrc - development or beta packages are not really the
                    159:   best thing for most places in which pkgsrc is used. Please use your
                    160:   judgement about what should go into pkgsrc, and bear in mind that
                    161:   stability is to be preferred above new and possibly untested features.</p>
                    162: </div>
                    163: <div class="sect1" lang="en">
                    164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.7     ! snj       165: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
        !           166: <p>Renaming packages is not recommended.</p>
        !           167: <p>When renaming packages, be sure to fix any references to old name
        !           168:   in other Makefiles, options, buildlink files, etc.</p>
        !           169: <p>Also When renaming a package, please define
        !           170:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
        !           171:   pattern(s) of the previous package name.
        !           172:   This may be repeated for multiple renames.
        !           173:   The new package would be an exact replacement.
        !           174: </p>
        !           175: <p>Note that &#8220;<span class="quote">successor</span>&#8221; in the
        !           176:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
        !           177:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
        !           178:   not be an exact replacement but is a suggestion for the replaced
        !           179:   functionality.</p>
        !           180: </div>
        !           181: <div class="sect1" lang="en">
        !           182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
        !           183: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
        !           184: <p>It is preferred that packages are not renamed or moved, but if needed
        !           185:   please follow these steps.
        !           186: </p>
1.1       dsieger   187: <div class="orderedlist"><ol type="1">
                    188: <li><p>Make a copy of the directory somewhere else.</p></li>
                    189: <li>
                    190: <p>Remove all CVS dirs.</p>
                    191: <p>Alternatively to the first two steps you can also do:</p>
                    192: <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>
                    193: <p>and use that for further work.</p>
                    194: </li>
                    195: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                    196: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                    197: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
1.7     ! snj       198: <li><p>In the modified package's Makefile, consider setting
        !           199: <code class="varname">PREV_PKGPATH</code> to the previous category/package
        !           200: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
        !           201: for doing an update using pkgsrc building; for example, it can
        !           202: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
        !           203: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
        !           204: new <code class="varname">PKGPATH</code> for that moved package.  Note that
        !           205: it may have multiple matches, so the tool should also check on the
        !           206: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
        !           207: probably has no value unless <code class="varname">SUPERSEDES</code> is not
        !           208: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.5       hubertf   209: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger   210: place.</p></li>
                    211: <li>
                    212: <p>Check if any package depends on it:
                    213: </p>
                    214: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                    215: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                    216: </li>
                    217: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.5       hubertf   218: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.1       dsieger   219: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                    220: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                    221: <li>
                    222: <p>Commit the changed and removed files:</p>
                    223: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                    224: <p>(and any packages from step 5, of course).</p>
                    225: </li>
                    226: </ol></div>
                    227: </div>
                    228: </div>
                    229: <div class="navfooter">
                    230: <hr>
                    231: <table width="100%" summary="Navigation footer">
                    232: <tr>
                    233: <td width="40%" align="left">
                    234: <a accesskey="p" href="debug.html">Prev</a> </td>
                    235: <td width="20%" align="center"><a accesskey="u" href="developers-guide.html">Up</a></td>
                    236: <td width="40%" align="right"> <a accesskey="n" href="devfaq.html">Next</a>
                    237: </td>
                    238: </tr>
                    239: <tr>
1.4       rillig    240: <td width="40%" align="left" valign="top">Chapter 20. Debugging </td>
1.1       dsieger   241: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.4       rillig    242: <td width="40%" align="right" valign="top"> Chapter 22. Frequently Asked Questions</td>
1.1       dsieger   243: </tr>
                    244: </table>
                    245: </div>
                    246: </body>
                    247: </html>

CVSweb <webmaster@jp.NetBSD.org>