Annotation of htdocs/developers/pkgsrc/index.html, revision 1.78

1.37      jschauma    1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1.64      mishka      2: <html>
1.1       dmcmahil    3: <head>
1.37      jschauma    4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1.56      wiz         5: <meta name="generator" content="Website XSL Stylesheet V2.6.0">
1.42      jschauma    6: <link rel="home" href="../../." title="Welcome to The NetBSD Project: Of course it runs NetBSD.">
                      7: <link rel="up" href="../../developers/." title="NetBSD Developer Documentation">
                      8: <link rel="previous" href="../../developers/pgp.html" title="PGP Key Management Guide for NetBSD developers">
                      9: <link rel="next" href="../../developers/pkgsrc/pkg-bug-handler.html" title="pkg-bug-handler group">
1.58      heinz      10: <link rel="first" href="../../developers/announce.html" title="NetBSD Developer Documentation: News story guidelines">
                     11: <link rel="last" href="../../developers/www.html" title="NetBSD Developer Documentation: Information about the www
                     12:       mailing list">
1.73      dsieger    13: <link rel="stylesheet" href="/global.css" type="text/css">
1.57      rpaulo     14:   
                     15:   <title>NetBSD pkgsrc Developer Information</title>
1.1       dmcmahil   16: </head>
1.56      wiz        17: <body class="website"><div class="webpage">
1.73      dsieger    18: <a name="developers-pkgsrc-index"></a><div id="top"><a href="#mainContent" class="doNotDisplay doNotPrint">Skip to main content.</a></div>
                     19: <div id="header">
                     20: <div class="topNavigation">
1.76      dsieger    21: <span>» </span><a href="../../docs/guide/en/">
                     22:          The Guide</a> |
1.73      dsieger    23:        <a href="http://man.NetBSD.org/">Manual pages</a> |
1.78    ! kano       24:        <a href="../../mailinglists/">
1.76      dsieger    25:          Mailing lists</a> and
1.73      dsieger    26:        <a href="http://mail-index.NetBSD.org/">Archives</a> |
                     27:        <a href="http://cvsweb.NetBSD.org/">CVS repository</a> |
1.76      dsieger    28:        <a href="http://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd">Report</a>
                     29:        or 
1.77      dsieger    30:        <a href="http://www.NetBSD.org/support/query-pr.html">query</a> a bug |
1.76      dsieger    31:        <a href="../../docs/software/packages.html">
                     32:          Software Packages
                     33:        </a>
1.73      dsieger    34: </div>
                     35: <div class="centralHeader">
1.76      dsieger    36: <a href="../../"><img alt="[NetBSD Logo]" width="506" height="90" src="../../images/NetBSD-headerlogo.png"></a><div class="headerTools"><div id="headerSearch"><form method="get" action="http://www.google.com/custom">
1.74      dsieger    37: <input class="whiteOnBlack" type="text" name="q" onfocus="if(this.value==this.defaultValue ) this.value='';" size="12" maxlength="255" value="Search"><input type="hidden" name="cof" value="L:http://www.NetBSD.org/images/NetBSD-smaller.png;LH:200;LW:200;AH:center;AWFID:4f6b0499f0f58d2c;"><input type="hidden" name="domains" value="NetBSD.org"><input type="hidden" name="sitesearch" value="www.NetBSD.org"><input type="submit" value="Search">
1.73      dsieger    38: </form></div></div>
                     39: </div>
                     40: <div class="navBar">
1.76      dsieger    41: <span class="doNotDisplay">
                     42:          Navigation:
                     43:        </span><a href="../../">
                     44:          Home</a> | 
                     45:        <a href="../../about/">
                     46:          About</a> | 
                     47:        <a href="../../releases/">
                     48:          Download</a> | 
                     49:        <a href="../../docs/">
                     50:          Documentation</a> | 
                     51:        <a href="../../support/">
                     52:          Support</a> | 
                     53:        <a href="../../community/">
                     54:          Community</a> | 
                     55:        <a href="../../ports/">
                     56:          Ports</a>
1.73      dsieger    57: </div>
                     58: </div>
                     59: <div id="content"><div class="fullWidth"><div class="rowOfBoxes">
                     60: <h1>NetBSD pkgsrc Developer Information</h1>
1.48      wiz        61: <h3 class="title"><a name="oberview">Overview</a></h3>
1.6       dent       62: <ul>
1.37      jschauma   63: <li><a href="#introduction">Introduction</a></li>
                     64: <li><a href="#status">Status</a></li>
1.6       dent       65: </ul>
1.48      wiz        66: <h3 class="title"><a name="freeze">pkgsrc freeze guidelines</a></h3>
1.47      jschauma   67: <ul>
                     68: <li><a href="#goals">Goals</a></li>
                     69: <li><a href="#rules">Rules</a></li>
1.52      jschauma   70: <li><a href="#branch-todo">Things to do when branching</a></li>
1.47      jschauma   71: </ul>
1.48      wiz        72: <h3 class="title"><a name="importing-or-updating">Importing or updating packages</a></h3>
1.11      abs        73: <ul>
1.66      rillig     74: <li><a href="#import">How to import a new package or update a package</a></li>
1.37      jschauma   75: <li><a href="#pullup">Pulling up updates to branches</a></li>
1.11      abs        76: </ul>
1.48      wiz        77: <h3 class="title"><a name="bulk-builds">Bulk pkgsrc builds</a></h3>
1.6       dent       78: <ul>
1.37      jschauma   79: <li><a href="#bulkhowto">Setting up a bulk pkgsrc build</a></li>
                     80: <li><a href="#bulklogs">Currently Available Bulk Build Results</a></li>
1.57      rpaulo     81: <li><a href="#bulk-packages">Providing binary packages for ftp.NetBSD.org 
                     82:        (bulk-packages)</a></li>
1.6       dent       83: </ul>
1.48      wiz        84: <h3 class="title"><a name="weekly-pkgsrc-checks">Weekly pkgsrc checks</a></h3>
1.37      jschauma   85: <ul><li><a href="#weeklypkgsrc">Weekly-pkgsrc script</a></li></ul>
1.48      wiz        86: <h3 class="title"><a name="misc">Miscellaneous</a></h3>
1.6       dent       87: <ul>
1.37      jschauma   88: <li><a href="#todo">Handling the TODO List</a></li>
                     89: <li><a href="#pkg-bug-handler">The pkg-bug-handler group</a></li>
1.6       dent       90: </ul>
1.1       dmcmahil   91: <hr>
1.37      jschauma   92: <h3 class="title">Overview</h3>
1.57      rpaulo     93:       <h4 class="title">
1.37      jschauma   94: <a name="introduction"></a>Introduction (<a href="#oberview">top</a>)
                     95:   </h4>
1.57      rpaulo     96: 
                     97:       <p>This page contains pointers to various pkgsrc related material.
1.1       dmcmahil   98:        The information here is likely to be most useful for pkgsrc
1.57      rpaulo     99:        developers.</p>
                    100:     
                    101:       <h4 class="title">
1.37      jschauma  102: <a name="status"></a>Status (<a href="#oberview">top</a>)
                    103:   </h4>
1.40      heinz     104: 
1.70      wiz       105:       <p>The NetBSD Packages Collection is currently
                    106:        <span class="bold"><strong>frozen</strong></span>
                    107:        since <a href="http://mail-index.NetBSD.org/tech-pkg/2006/12/15/0009.html" target="_top">2006-12-15</a>.
                    108:        See <a href="#goals" target="_top">below for details</a>.</p>
1.57      rpaulo    109: 
                    110:     <hr>
1.47      jschauma  111: <h3 class="title">pkgsrc freeze guidelines</h3>
1.57      rpaulo    112:       <h4 class="title">
1.47      jschauma  113: <a name="goals"></a>Goals (<a href="#freeze">top</a>)
                    114:   </h4>
                    115: 
1.69      kano      116:       <p>The primary goal of the pkgsrc freeze is to produce the 
1.57      rpaulo    117:        next stable branch of pkgsrc. Commits to the pkgsrc HEAD 
                    118:        during a freeze should be aimed at reducing the open
1.66      rillig    119:        <a href="../../Gnats/category/pkg.html" target="_top">pkgsrc-related PR</a>
1.57      rpaulo    120:        count and reducing the number of broken packages in the bulk 
                    121:        builds.</p>
                    122:     
                    123:       <h4 class="title">
1.47      jschauma  124: <a name="rules"></a>Rules (<a href="#freeze">top</a>)
                    125:   </h4>
1.57      rpaulo    126:       
                    127:       <div class="orderedlist"><ol type="1">
                    128: <li>No infrastructure changes nor new packages should be 
                    129:          committed. This includes non-trivial changes to 
1.64      mishka    130:          <code class="filename">buildlink3.mk</code> files.</li>
1.57      rpaulo    131: <li>Package updates are only allowed for leaf packages 
1.65      rillig    132:          or for packages with security issues. For non-leaf packages
                    133:          approval must be asked for and given (by pkgsrc-pmc) on the <a href="mailto:packages@NetBSD.org" target="_top">pkgsrc developers</a>
1.57      rpaulo    134:          mailing list.</li>
1.50      jschauma  135: <li>Approval requests to the
1.57      rpaulo    136:          <a href="mailto:packages@NetBSD.org" target="_top">pkgsrc developers</a>
                    137:          mailing list must answer the following questions:
1.50      jschauma  138: 
1.57      rpaulo    139:          <div class="itemizedlist"><ul type="disc">
                    140: <li>Why is it critical to update this package for the 
                    141:              upcoming branch?</li>
                    142: <li>What changes should be expected between the current 
                    143:              version and the updated version?</li>
1.50      jschauma  144: </ul></div>
1.57      rpaulo    145:        </li>
1.47      jschauma  146: <li>Commits should only be made to fix portability issues,
1.57      rpaulo    147:          build problems, or for addressing open PRs.</li>
                    148: <li>Commit messages should note explicitly why the commits 
                    149:          were made during the freeze period, and if necessary, who 
                    150:          gave the approval, e.g.:
                    151:          
                    152:          <div class="itemizedlist"><ul type="disc">
1.47      jschauma  153: <li>&#8220;<span class="quote">Updated during the freeze to fix security issue
1.57      rpaulo    154:              noted at http://...; approved by ...</span>&#8221;</li>
                    155: <li>&#8220;<span class="quote">Updated during the freeze to fix problem noted
                    156:              n pkg/NNNNN; approved by ...</span>&#8221;</li>
1.47      jschauma  157: <li>&#8220;<span class="quote">Fix build on Darwin due to issues with
1.64      mishka    158:              <code class="filename">namesrv8_compat.h</code></span>&#8221;</li>
1.47      jschauma  159: </ul></div>
1.57      rpaulo    160:        </li>
1.51      wiz       161: <li>The pkgsrc &#8220;<span class="quote">regress</span>&#8221; and &#8220;<span class="quote">doc</span>&#8221;
1.57      rpaulo    162:          categories are exempt from the freeze.</li>
1.47      jschauma  163: </ol></div>
1.57      rpaulo    164:     
                    165:       <h4 class="title">
1.52      jschauma  166: <a name="branch-todo"></a>Things to do when branching (<a href="#freeze">top</a>)
                    167:   </h4>
1.57      rpaulo    168: 
                    169:       <div class="itemizedlist"><ul type="disc">
                    170: <li>Send an announcement to
                    171:          <code class="email">&lt;<a href="mailto:netbsd-announce@NetBSD.org">netbsd-announce@NetBSD.org</a>&gt;</code>.</li>
                    172: <li>Send an announcement to <code class="email">&lt;<a href="mailto:www@NetBSD.org">www@NetBSD.org</a>&gt;</code> or 
                    173:          make the website announcement yourself (see <a href="../htdocs.html#adding-news-items" target="_top">this link</a>).</li>
                    174: <li>Update
1.72      dsieger   175:          <code class="filename">htdocs/docs/software/pkgsrc-home.xsl</code>;
1.64      mishka    176:          regen <code class="filename">packages.html</code> and commit.</li>
1.57      rpaulo    177: <li>Update
1.64      mishka    178:          <code class="filename">htdocs/developers/pkgsrc/index.xml</code>; 
                    179:          commit <code class="filename">index.xml</code>; regen
                    180:          <code class="filename">index.html</code> and commit.</li>
1.52      jschauma  181: </ul></div>
1.57      rpaulo    182:     <hr>
1.37      jschauma  183: <h3 class="title">Importing or updating packages</h3>
1.57      rpaulo    184:       <h4 class="title">
1.66      rillig    185: <a name="import"></a>How to import a new package or update a package (<a href="#importing-or-updating">top</a>)
1.37      jschauma  186:   </h4>
1.57      rpaulo    187:       
1.72      dsieger   188:       <p>This is explained in detail in the <a href="http://www.NetBSD.org/docs/pkgsrc/submit.html#committing-importing" target="_top">pkgsrc Guide</a>.</p>
1.57      rpaulo    189:     
                    190:       <h4 class="title">
1.37      jschauma  191: <a name="pullup"></a>Pulling up updates to branches (<a href="#importing-or-updating">top</a>)
                    192:   </h4>
1.25      wiz       193: 
1.57      rpaulo    194:       <p>Critical bug fixes, security updates, and build fixes can be 
                    195:        pulled up to the latest stable pkgsrc branch. Please forward 
                    196:        the &#8220;<span class="quote">cvs commit</span>&#8221; mail from the pkgsrc-changes 
                    197:        mailing list to the <a href="mailto:pullup-pkgsrc@NetBSD.org" target="_top">pullup</a> address.</p>
                    198: 
                    199:       <p>The pkgsrc pullup ticket tracking summaries are found by adding
                    200:        &#8220;<span class="quote">req/index-pkgsrc.html</span>&#8221; to the 
                    201:        http://releng.NetBSD.org/ URL. (Not directly linked to avoid 
                    202:        automated e-mail spidering.)</p>
                    203:     <hr>
1.37      jschauma  204: <h3 class="title">Bulk pkgsrc builds</h3>
1.57      rpaulo    205:       <h4 class="title">
1.37      jschauma  206: <a name="bulkhowto"></a>Setting up a bulk pkgsrc build (<a href="#bulk-builds">top</a>)
                    207:   </h4>
1.1       dmcmahil  208: 
1.72      dsieger   209:       <p>The <a href="http://www.NetBSD.org/docs/pkgsrc/binary.html#bulkbuild" target="_top">bulkbuild section</a>
                    210:       of the <a href="../../docs/pkgsrc/" target="_top">pkgsrc documentation</a>
1.57      rpaulo    211:        describes how to set up a bulk pkgsrc build.</p>
                    212:     
                    213:       <h4 class="title">
1.37      jschauma  214: <a name="bulklogs"></a>Currently Available Bulk Build Results (<a href="#bulk-builds">top</a>)
                    215:   </h4>
1.1       dmcmahil  216: 
1.72      dsieger   217:       <p>The results of various bulk pkgsrc builds are posted to the <a href="../../mailinglists/#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>
1.66      rillig    218:          mailing list.</p>
1.57      rpaulo    219:     
                    220:       <h4 class="title">
                    221: <a name="bulk-packages"></a>Providing binary packages for ftp.NetBSD.org 
                    222:        (bulk-packages) (<a href="#bulk-builds">top</a>)
                    223:   </h4>
                    224: 
                    225:       <p>We need to coordinate providing a good set of binary packages
                    226:        for as many arch/osrev combinations as possible.</p>
                    227:       
                    228:       <p>It is critical to ensure binary packages are built against the
                    229:        same set of depends to avoid install conflicts. The most
                    230:        practical way to arrange this is to use the bulk building system
                    231:        and upload the complete set of packages after every build.</p>
                    232:       
                    233:       <p>Developers interested in assisting (all are invited) should
                    234:        subscribe to the <code class="email">&lt;<a href="mailto:pkgsrc-bulk@NetBSD.org">pkgsrc-bulk@NetBSD.org</a>&gt;</code> list, and 
                    235:        check <code class="filename">localsrc/admin/bulk-packages</code> for an
                    236:        available arch/osrev combination.</p>
1.37      jschauma  237: 
1.57      rpaulo    238:       <div class="sect4" lang="en">
1.37      jschauma  239: <div class="titlepage"><div><div><h5 class="title">
                    240: <a name="conventions"></a>bulk-packages conventions:</h5></div></div></div>
1.57      rpaulo    241:        
1.15      abs       242: 
1.57      rpaulo    243:        <div class="itemizedlist"><ul type="disc">
1.37      jschauma  244: <li>When taking over an arch/osrev combination either start
1.57      rpaulo    245:            bulk building from scratch, or download the current set of
                    246:            binary packages from ftp.NetBSD.org to 'pre seed' the
                    247:            build process (most useful for slower architectures).</li>
                    248: <li>When uploading packages upload/rsync the entire set 
                    249:            of bulk built packages, and delete any other packages for that
                    250:            arch/osrev from ftp.NetBSD.org.</li>
1.46      minskim   251: <li>If no longer able to handle a build, remove the entry
1.64      mishka    252:            from <code class="filename">localsrc/admin/bulk-packages</code> and 
1.57      rpaulo    253:            notify  pkgsrc-bulk.</li>
                    254: <li>Any developer can upload updated/new/security-fix 
                    255:            packages to ftp.NetBSD.org, but they 
                    256:            <span class="emphasis"><em>must</em></span> be built against the set of binary 
                    257:            packages already present for that arch/osrev.</li>
                    258: <li>Machines should run the latest minor release, 
                    259:            or (recommended) track the release branch.</li>
1.37      jschauma  260: </ul></div>
1.57      rpaulo    261:        
                    262:        <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.46      minskim   263: <h3 class="title">Note</h3>
1.57      rpaulo    264: <p>This does not address the issue of new versions of
                    265:          binary packages not installing against a user's existing 
                    266:          set of installed depends, or a updated depend potentially 
                    267:          requiring an update of many other packages already installed 
                    268:          in their machine.</p>
                    269:          
                    270:        <p>Current options for that would be either freezing binary 
                    271:          packages at tagged values, or having multiple binary package 
                    272:          trees per arch/osrev. The former significantly reduces the 
                    273:          utility of the binary packages, and the latter is not worth 
                    274:          considering until we can get <span class="emphasis"><em>one</em></span> 
                    275:          consistent tree per arch/osrev.</p>
1.37      jschauma  276: </div>
1.57      rpaulo    277:       </div>
                    278:     <hr>
1.37      jschauma  279: <h3 class="title">Weekly pkgsrc checks</h3>
1.57      rpaulo    280:       <h4 class="title">
1.37      jschauma  281: <a name="weeklypkgsrc"></a>Weekly-pkgsrc script (<a href="#weekly-pkgsrc-checks">top</a>)
                    282:   </h4>
1.1       dmcmahil  283: 
1.57      rpaulo    284:       <p>
                    285:        <a href="mailto:dmcmahill@NetBSD.org" target="_top">Dan McMahill</a> 
                    286:        maintains a script that is run once a week to perform various 
                    287:        pkgsrc consistency checks. The currentset of checks are:</p>
                    288:       
                    289:       <div class="itemizedlist"><ul type="disc">
                    290: <li>
                    291: <code class="code">DEPENDS</code> &#8212; verifies that all 
                    292:          <code class="code">{BUILD_}DEPENDS</code> are set to valid versions.</li>
                    293: <li>
1.64      mishka    294: <code class="filename">distinfo</code> &#8212; verifies 
1.57      rpaulo    295:          distfile checksums and sizes, and that all patches are listed 
                    296:          and their checksums match.</li>
1.66      rillig    297: <li>category makefiles &#8212; verifies all packages are listed 
1.57      rpaulo    298:          in the category makefiles.</li>
1.66      rillig    299: <li>restricted binary packages &#8212; warns of any restricted 
                    300:          binary packages.</li>
1.57      rpaulo    301: <li>vulnerable packages &#8212; verifies all vulnerable
                    302:          packages.</li>
1.37      jschauma  303: </ul></div>
1.57      rpaulo    304: 
                    305:       <p>The results of these checks are emailed to NetBSD pkgsrc 
                    306:        developers.</p>
                    307:     <hr>
1.37      jschauma  308: <h3 class="title">Miscellaneous</h3>
1.57      rpaulo    309:       <h4 class="title">
1.37      jschauma  310: <a name="todo"></a>Handling the TODO List (<a href="#misc">top</a>)
                    311:   </h4>
                    312: 
1.57      rpaulo    313:       <p>There's a <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/doc/TODO" target="_top">TODO</a>
                    314:        list in the pkgsrc doc directory. Feel free to add, and especially
                    315:        remove items from there (after solving the mentioned problem, of
                    316:        course).</p>
                    317:     
                    318:       <h4 class="title">
1.37      jschauma  319: <a name="pkg-bug-handler"></a>The pkg-bug-handler group (<a href="#misc">top</a>)
                    320:   </h4>
1.57      rpaulo    321: 
1.66      rillig    322:       <p>In order to manage the large number of pkgsrc-related problem 
1.57      rpaulo    323:        reports each day, the &#8220;<span class="quote">pkg-bug-handler</span>&#8221; group 
                    324:        has been created.  See <a href="pkg-bug-handler.html" target="_top">this page</a> for details.</p>
1.73      dsieger   325:     <hr>Back to  <em><a href="../">NetBSD Developer Documentation</a></em>
                    326: </div></div></div>
                    327: <div class="navfoot"></div>
                    328: <div id="footer"><center>
                    329: <span class="footfeed"><a href="http://www.NetBSD.org/cgi-bin/feedback.cgi">
                    330:          Contact</a> |
                    331:       </span><span class="footcopy"><a href="/about/disclaimer.html">
                    332:       Disclaimer</a> |
                    333: 
                    334:       <span class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc. </span>ALL RIGHTS RESERVED.<br>NetBSD<sup>®</sup> is a registered trademark of The NetBSD
                    335:        Foundation, Inc.</span>
                    336: </center></div>
1.37      jschauma  337: </div></body>
1.1       dmcmahil  338: </html>

CVSweb <webmaster@jp.NetBSD.org>