Annotation of htdocs/developers/PR.html, revision 1.78

1.56      jym         1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
1.1       hubertf     2: <html>
                      3: <head>
1.35      hubertf     4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <meta name="generator" content="Website XSL Stylesheet V2.6.0">
                      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">
1.45      kano        8: <link rel="previous" href="../developers/htdocs.html" title="Editing htdocs">
1.35      hubertf     9: <link rel="next" href="../developers/manpages.html" title="NetBSD man page style">
                     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.47      dsieger    13: <link rel="stylesheet" href="../global.css" type="text/css">
1.19      dent       14: <title>Resolving Problem Reports</title>
1.1       hubertf    15: </head>
1.35      hubertf    16: <body class="website"><div class="webpage">
1.39      dsieger    17: <a name="developers-PR"></a><div id="top"><a href="#mainContent" class="doNotDisplay doNotPrint">Skip to main content.</a></div>
1.70      maya       18: <div id="centralHeader"><div id="logo">
1.60      jym        19: <a href="../"><img alt="[NetBSD Logo]" src="../images/NetBSD-smaller.png"></a><div id="name"><a href="../">
1.58      jym        20:          The NetBSD Project
1.60      jym        21:        </a></div>
                     22: <div id="slogan"><a href="../">
1.58      jym        23:          &#8220;Of course it runs NetBSD&#8221;
1.60      jym        24:        </a></div>
1.70      maya       25: </div></div>
1.71      maya       26: <input id="hamburger" type="checkbox"><label class="menuicon" for="hamburger"><span></span></label><div id="navBar" role="navigation">
1.42      dsieger    27: <span class="doNotDisplay">
                     28:          Navigation:
1.56      jym        29:        </span><ul>
                     30: <li><a href="../">
                     31:          Home</a></li>
                     32: <li>
                     33: <a href="../">
1.59      wiz        34:          News &amp; Media</a><ul>
1.56      jym        35: <li><a href="../changes/">
                     36:            Recent changes</a></li>
1.73      maya       37: <li><a href="//blog.NetBSD.org/">
1.56      jym        38:            NetBSD blog</a></li>
                     39: <li><a href="../gallery/events.html">
                     40:            Events</a></li>
                     41: <li><a href="../changes/rss.html">
                     42:            Feeds</a></li>
                     43: </ul>
                     44: </li>
                     45: <li>
                     46: <a href="../about/">
                     47:          About</a><ul>
                     48: <li><a href="../about/">
                     49:            NetBSD</a></li>
                     50: <li><a href="../foundation/">
                     51:            The NetBSD Foundation</a></li>
                     52: <li><a href="../gallery/">
                     53:            Advocacy</a></li>
                     54: </ul>
                     55: </li>
                     56: <li>
                     57: <a href="../docs/">
                     58:          Documentation</a><ul>
                     59: <li><a href="../docs/misc/index.html">
                     60:            FAQ &amp; HOWTOs</a></li>
                     61: <li><a href="../docs/guide/en/">
                     62:            The Guide</a></li>
1.74      maya       63: <li><a href="http://man.NetBSD.org/">
1.56      jym        64:            Manual pages</a></li>
1.73      maya       65: <li><a href="//wiki.NetBSD.org/">
1.56      jym        66:            Wiki</a></li>
                     67: </ul>
                     68: </li>
                     69: <li>
                     70: <a href="../support/">
                     71:          Support</a><ul>
                     72: <li><a href="../support/send-pr.html">
                     73:            Problem report guide</a></li>
                     74: <li><a href="../cgi-bin/sendpr.cgi?gndb=netbsd">
                     75:            Report a bug</a></li>
                     76: <li><a href="../support/query-pr.html">
                     77:            Query bug database</a></li>
                     78: <li><a href="../support/security/">
                     79:            Security</a></li>
                     80: </ul>
                     81: </li>
                     82: <li>
                     83: <a href="../community/">
                     84:          Community</a><ul>
1.78    ! leot       85: <li><a href="//blog.NetBSD.org/">
        !            86:            Blog</a></li>
1.56      jym        87: <li><a href="../mailinglists/">
                     88:            Mailing lists</a></li>
1.73      maya       89: <li><a href="//mail-index.NetBSD.org/">
1.56      jym        90:            List archives</a></li>
                     91: </ul>
                     92: </li>
                     93: <li>
                     94: <a href="../developers/">
                     95:          Developers</a><ul>
1.77      maya       96: <li><a href="http://cvsweb.NetBSD.org/">
1.56      jym        97:            Browse source</a></li>
1.73      maya       98: <li><a href="//nxr.NetBSD.org/">
1.56      jym        99:            Cross-reference</a></li>
1.73      maya      100: <li><a href="//releng.NetBSD.org/">
1.56      jym       101:            Release engineering</a></li>
1.73      maya      102: <li><a href="//wiki.NetBSD.org/projects/">
1.56      jym       103:            Projects list</a></li>
                    104: </ul>
                    105: </li>
                    106: <li>
                    107: <a href="../ports/">
                    108:          Ports</a><ul>
                    109: <li><a href="../ports/history.html">
                    110:            History</a></li>
                    111: <li><a href="../ports/emulators.html">
                    112:            Emulators</a></li>
                    113: </ul>
                    114: </li>
                    115: <li>
1.73      maya      116: <a href="//www.pkgsrc.org/">
1.56      jym       117:          Packages</a><ul>
1.74      maya      118: <li><a href="http://www.pkgsrc.se/">
1.56      jym       119:            Browse packages</a></li>
1.73      maya      120: <li><a href="//releng.NetBSD.org/index-pkgsrc.html">
1.56      jym       121:            Release engineering</a></li>
                    122: </ul>
                    123: </li>
                    124: </ul>
1.39      dsieger   125: </div>
                    126: <div id="content"><div class="fullWidth"><div class="rowOfBoxes">
                    127: <h1>Resolving Problem Reports</h1>
1.35      hubertf   128: <h3 class="title"><a name="top">Resolving Problem Reports</a></h3>
1.20      dent      129: <ul>
1.35      hubertf   130: <li><a href="#intro">Introduction</a></li>
                    131: <li><a href="#access">Accessing the Problem Report Database</a></li>
                    132: <li><a href="#resolve">Resolving Problem Reports</a></li>
                    133: <li><a href="#priorities"> Priorities, Severities, and Releases</a></li>
                    134: <li><a href="#remotegnats">Remote GNATS Operations</a></li>
1.20      dent      135: </ul>
1.19      dent      136: <hr>
1.35      hubertf   137: <h3 class="title">Resolving Problem Reports</h3>
                    138: <h4 class="title">
                    139: <a name="intro"></a>Introduction (<a href="#top">top</a>)
                    140:   </h4>
1.54      spz       141: <p>The NetBSD Project uses the GNATS <span class="quote">&#8220;<span class="quote">Problem Report</span>&#8221;</span>
1.35      hubertf   142:   database to accept and track bug/problem reports from all users of
                    143:   NetBSD. When used properly, this facility allows us to make sure
                    144:   that no problem with the NetBSD software goes unfixed.</p>
                    145: 
                    146: <p>The GNATS database uses Internet E-mail as its principal
                    147:   submission mechanism, and keeps the problem reports (commonly
1.54      spz       148:   abbreviated <span class="quote">&#8220;<span class="quote">PR</span>&#8221;</span>) in Internet E-mail format, with an
1.35      hubertf   149:   extended header format in the body of the message. The database uses
                    150:   one file per PR, and each category is a directory, in a manner
                    151:   similar to the MH mail system, and NetNews.</p>
                    152: 
                    153: <h4 class="title">
                    154: <a name="access"></a>Accessing the Problem Report Database (<a href="#top">top</a>)
                    155:   </h4>
                    156: 
1.61      tron      157: <div class="sect4">
1.35      hubertf   158: <div class="titlepage"><div><div><h5 class="title">
                    159: <a name="webinterface"></a>Web Interface</h5></div></div></div>
                    160: 
                    161: 
                    162: <p>There is a web-based interface to the GNATS database that has
1.47      dsieger   163:   both a <a class="ulink" href="../Gnats/" target="_top">tree of database summary pages</a>, and a <a class="ulink" href="../support/query-pr.html" target="_top">search</a> facility. The web interface
1.35      hubertf   164:   has some limitations:</p>
                    165: 
1.61      tron      166: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.54      spz       167: <li class="listitem">The web interface <span class="emphasis"><em>does not</em></span> provide
                    168:     access to any PR marked <span class="quote">&#8220;<span class="quote">confidential</span>&#8221;</span>.</li>
                    169: <li class="listitem">PRs displayed by a web browser have been through
                    170:     sufficient transformation that <span class="quote">&#8220;<span class="quote">cut &amp; paste</span>&#8221;</span> is
1.35      hubertf   171:     not likely to do what you expect (i.e. patches will not apply
                    172:     properly because of white space substitution, uuencoded text
                    173:     will not decode properly).</li>
                    174: </ul></div>
                    175: </div>
                    176: 
1.61      tron      177: <div class="sect4">
1.35      hubertf   178: <div class="titlepage"><div><div><h5 class="title">
                    179: <a name="netbsd-bugs"></a>The netbsd-bugs Mailing List</h5></div></div></div>
                    180: 
                    181: 
1.53      spz       182: <p>All PRs except confidential ones are sent to the <a class="ulink" href="/mailinglists/#netbsd-bugs" target="_top">netbsd-bugs</a> mailing list,
1.35      hubertf   183:   so that subscribers can see each PR as it is added to the
                    184:   database.</p>
                    185: </div>
                    186: 
1.61      tron      187: <div class="sect4">
1.35      hubertf   188: <div class="titlepage"><div><div><h5 class="title">
                    189: <a name="gnatscommands"></a>The GNATS commands on gnats.NetBSD.org</h5></div></div></div>
                    190: 
                    191: 
                    192: <p>The GNATS database lives on the host gnats.NetBSD.org.  All
                    193:   developers are given an account on that host so that they can
                    194:   directly manipulate PRs, and access confidential PRs. The commands
1.47      dsieger   195:   <span class="command"><strong>edit-pr</strong></span> and <span class="command"><strong>query-pr</strong></span> live in
1.35      hubertf   196:   <code class="filename">/usr/pkg/bin</code>; Make sure you have that directory
                    197:   in your <code class="varname">$PATH</code>.</p>
                    198: 
1.47      dsieger   199: <p>The <span class="command"><strong>query-pr</strong></span> command is a proper database
1.35      hubertf   200:   query interface; it has a large number of options to search the
                    201:   database. Once you know the PR number of the PR you wish to
                    202:   manipulate, you can:</p>
                    203: 
1.61      tron      204: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.54      spz       205: <li class="listitem">
1.47      dsieger   206:     <p><span class="command"><strong>query-pr --full</strong></span> &lt;number&gt;</p>
1.35      hubertf   207:     <p>This will dump out the full PR without any transformation to
                    208:       standard output.</p>
                    209:   </li>
1.54      spz       210: <li class="listitem">
1.47      dsieger   211:     <p><span class="command"><strong>edit-pr</strong></span> &lt;number&gt;</p>
1.35      hubertf   212:     <p>This command will start up a text editor
                    213:       (<span class="application">vi</span> by default; but this can be
                    214:       overridden by the <code class="varname">$EDITOR</code> or
                    215:       <code class="varname">$VISUAL</code> environment variables), so that
                    216:       changes can be made to the PR.</p>
1.53      spz       217:     <p>Please don't kill your edit-pr without checking for a left-over
                    218:       shell afterwards (also check if you lost your connection with
                    219:       edit-pr running).</p>
1.35      hubertf   220:   </li>
                    221: </ul></div>
1.68      leot      222: 
                    223: <p>For more information please consult <code class="literal">edit-pr(1)</code> or
                    224:   <code class="literal">query-pr(1)</code> man pages.  As with most GNU software,
                    225:   there are also <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> pages available through the
                    226:   <span class="command"><strong>info</strong></span> command. Also, invoking
                    227:   <span class="command"><strong>edit-pr</strong></span> or <span class="command"><strong>query-pr</strong></span> without any
                    228:   arguments will cause it to give its usage message.</p>
1.35      hubertf   229: </div>
                    230: 
1.61      tron      231: <div class="sect4">
1.35      hubertf   232: <div class="titlepage"><div><div><h5 class="title">
1.47      dsieger   233: <a name="edit-pr"></a>The Common Reasons to <span class="command"><strong>edit-pr</strong></span>
1.37      darcy     234: </h5></div></div></div>
1.35      hubertf   235: 
                    236: 
                    237: <p>The most common changes made to a PR are:</p>
                    238: 
1.54      spz       239: <div class="orderedlist"><ol class="orderedlist" type="1">
                    240: <li class="listitem">
1.35      hubertf   241:     <p>Change the PR's <code class="code">&gt;State:</code> field to one of the values
1.47      dsieger   242:       listed in <a class="ulink" href="../support/send-pr.html" target="_top">state</a> as it progresses
1.35      hubertf   243:       through the process of resolving it.</p>
                    244:     <p>The person listed in the <code class="code">&gt;Responsible:</code> field of the
                    245:       PR should be making these state changes, as it is necessary.</p>
                    246:   </li>
1.54      spz       247: <li class="listitem">
1.35      hubertf   248:     <p>Change the PR's <code class="code">&gt;Responsible:</code> field to the account name
                    249:       of a developer who will handle the PR.
                    250:       This person becomes the PR Submitter's primary contact for
                    251:       getting the problem resolved.</p>
                    252:     <p>This field can have any username from /etc/passwd on
                    253:       <code class="code">gnats.NetBSD.org</code> and anyone listed in the
1.75      jnemeth   254:       <code class="filename">/home/gnats/gnatsdb/gnats-adm/responsible</code>
1.35      hubertf   255:       file.</p>
                    256:     <p>All PRs get a default Responsible Person when they are
                    257:       initially filed, appropriate to the category in which the PR
1.54      spz       258:       was filed (e.g.  <span class="quote">&#8220;<span class="quote">security-officer</span>&#8221;</span> for PRs in
                    259:       the <span class="quote">&#8220;<span class="quote">security</span>&#8221;</span> category). The
1.75      jnemeth   260:       <code class="filename">/home/gnats/gnatsdb/gnats-adm/categories</code>
1.35      hubertf   261:       file lists the default Responsible Person for each
                    262:       category.</p>
1.47      dsieger   263:     <p>There is also a table of <a class="ulink" href="../Gnats/#table-responsible" target="_top">developers responsible for
1.35      hubertf   264:       current PRs</a>.</p>
                    265:   </li>
1.54      spz       266: <li class="listitem">
1.35      hubertf   267:     <p>Change the PR's <code class="code">&gt;Category:</code> field.</p>
                    268:     <p>It is not unusual for a PR Submitter to have made a poor
1.47      dsieger   269:       category choice. There is a list of <a class="ulink" href="../Gnats/#category-descriptions" target="_top">PR categories and their
                    270:       definitions</a> and a table of <a class="ulink" href="../Gnats/#table-category" target="_top">current PRs by
1.35      hubertf   271:       category</a>.</p>
                    272:     <p>The
1.75      jnemeth   273:       <code class="filename">/home/gnats/gnatsdb/gnats-adm/categories</code>
1.35      hubertf   274:       file lists the valid categories and the default Responsible
                    275:       Person.  It is usually necessary to change the
                    276:       <code class="code">&gt;Responsible:</code> field at the same time to a more
                    277:       appropriate person. Most often, the correct Responsible Person
                    278:       is the default Responsible Person for the new category.</p>
                    279:   </li>
1.54      spz       280: <li class="listitem">
1.63      spz       281:     <p>Add themselves to the PR's <code class="code">&gt;Notify-List:</code> field.</p>
                    282:     <p>If you have an interest in the PR without being the submitter
                    283:       nor <code class="code">&gt;Responsible</code> for it, add yourself to this field.
                    284:       You may have to insert it.</p>
                    285:   </li>
                    286: <li class="listitem">
1.47      dsieger   287:     <p>Change other <a class="ulink" href="../support/send-pr.html" target="_top">PR
1.35      hubertf   288:       Fields</a> according to the analysis of the responsible
                    289:       developer.</p>
                    290:   </li>
                    291: </ol></div>
                    292: 
                    293: <p>Edit each field you think needs modifying, then save the file
1.47      dsieger   294:   and exit the editor. The <span class="command"><strong>edit-pr</strong></span> will then
1.35      hubertf   295:   prompt for a short explanation to be typed for each key field
                    296:   change (mostly <code class="code">&gt;State:</code> and
                    297:   <code class="code">&gt;Responsible:</code>). This text is entered one line at
1.47      dsieger   298:   time, ending with <span class="command"><strong>^D</strong></span>.</p>
1.35      hubertf   299: 
                    300: <p>This text is then sent via e-mail to the PR Submitter, the
1.47      dsieger   301:   Responsible developer, and <code class="email">&lt;<a class="email" href="mailto:gnats-admin@NetBSD.org">gnats-admin@NetBSD.org</a>&gt;</code>.
                    302:   It is also appended to the PR by <span class="command"><strong>edit-pr</strong></span> along
1.35      hubertf   303:   with the user ID of the developer making the change, a timestamp,
                    304:   and the entered text.</p>
                    305: 
                    306:   <p>Unfortunately, no external editor can be invoked at this
                    307:     point; if you make a mistake, you'll have to use
1.47      dsieger   308:     <span class="command"><strong>edit-pr</strong></span> to correct it.</p>
1.35      hubertf   309: </div>
                    310: 
                    311:   <h4 class="title">
                    312: <a name="resolve"></a>Resolving Problem Reports (<a href="#top">top</a>)
                    313:   </h4>
                    314: 
1.61      tron      315:   <div class="sect4">
1.35      hubertf   316: <div class="titlepage"><div><div><h5 class="title">
                    317: <a name="ideal"></a>The Ideal Process</h5></div></div></div>
                    318:     
                    319: 
                    320:     <p>In an ideal world, the process for a problem report is as
                    321:       follows:</p>
                    322: 
1.54      spz       323:     <div class="orderedlist"><ol class="orderedlist" type="1">
                    324: <li class="listitem">
1.35      hubertf   325:         <p>A NetBSD user has a problem with NetBSD. He invokes the
1.47      dsieger   326:          <span class="command"><strong>send-pr</strong></span> command on his system (assuming
1.35      hubertf   327:          it's still stable enough to do that), and files a Problem
1.47      dsieger   328:          Report. Hopefully, he follows all the advice found in <a class="ulink" href="../support/send-pr.html" target="_top">"What goes into a Problem
1.35      hubertf   329:          Report."</a></p>
                    330:        <p>If the user's own system is not stable enough to use
1.49      weinem    331:          <span class="command"><strong>send-pr</strong></span>, there is a <a class="ulink" href="http://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">web interface</a>
1.48      jnemeth   332:           that can be used to submit problem reports.</p>
1.35      hubertf   333:       </li>
1.54      spz       334: <li class="listitem">
1.35      hubertf   335:         <p>When the PR arrives at <code class="code">gnats.NetBSD.org</code>,
                    336:          the GNATS database system examines it, and files it. If the
                    337:          PR is malformed, it will be filed in the
                    338:          <code class="code">pending</code> category, marked confidential, awaiting
                    339:          manual intervention by the GNATS database
                    340:          administrator.</p>
                    341:        <p>If the format is OK, the PR is assigned a PR number,
                    342:          filed into the requested category, and E-mailed out again to
                    343:          the default responsible party for the category, and to the
1.47      dsieger   344:          <a class="ulink" href="../mailinglists/#netbsd-bugs" target="_top">netbsd-bugs</a>
1.35      hubertf   345:          mailing list.  A notice of the PR number and default
                    346:          Responsible Person is also E-mailed back to the PR
                    347:          Submitter.</p>
                    348:       </li>
1.54      spz       349: <li class="listitem">
1.35      hubertf   350:         <p>The Responsible Person should read and analyze the
                    351:          PR. Any other person who has insight into the problem should
1.47      dsieger   352:          also <a class="ulink" href="../support/send-pr.html#appending" target="_top">add
1.35      hubertf   353:          whatever information they can to the problem report</a>
                    354:          (this is why the report is mailed out to a mailing list; a
                    355:          wide audience increases the probability that a key insight
                    356:          needed to solve the problem will be discovered).</p>
                    357: 
                    358:        <p>If the default Responsible Person determines that
                    359:          another developer is a more appropriate Responsible Person,
                    360:          the PR should be reassigned with
1.47      dsieger   361:          <span class="command"><strong>edit-pr</strong></span>. The new Responsible Person
1.35      hubertf   362:          should read and analyze the PR.</p>
                    363:       </li>
1.54      spz       364: <li class="listitem">
1.35      hubertf   365:         <p>Once a cause and potential fix has been identified, a
1.47      dsieger   366:          description should be added to the PR, and the <a class="ulink" href="../support/send-pr.html" target="_top">state</a> should be changed
1.35      hubertf   367:          to <code class="code">analyzed</code>. At this point, implementation of
                    368:          the fix for the problem begins.</p>
                    369:        <p>This part of the process should begin as quickly as
                    370:          possible, since a user with a current problem is suffering,
                    371:          but also has his attention engaged, and his hardware
                    372:          available for testing potential fixes. If a PR is allowed to
                    373:          languish, the opportunity to reproduce the problem and test
                    374:          potential fixes may be lost.</p>
                    375:       </li>
1.54      spz       376: <li class="listitem">
1.35      hubertf   377:         <p>Once the implementation of the fix is completed and communicated
1.49      weinem    378:          to the PR submitter, the PR <a class="ulink" href="../support/send-pr.html" target="_top">state</a>
1.35      hubertf   379:          should be changed to <code class="code">feedback</code>, awaiting response from the PR
                    380:          submitter that the fix really works.</p>
                    381:        <p>A PR should also be put into <code class="code">feedback</code> state when input
                    382:          is required from the submitter to complete the analysis of the PR
                    383:          (i.e. when you ask them a question), or when you need information
                    384:          from some other source (essentially, <code class="code">feedback</code> is a wait
                    385:          state).</p>
                    386:       </li>
1.54      spz       387: <li class="listitem">
1.48      jnemeth   388:         <p>Once it is confirmed that the problem has been fixed, it
                    389:           should be pulled up to the appropriate active branches.  After
                    390:           sending the pullup request(s), you should set the PR
1.49      weinem    391:           <a class="ulink" href="../support/send-pr.html" target="_top">state</a> to
1.48      jnemeth   392:           <code class="code">pending-pullups</code>, and list the pullup number(s)
                    393:           in the reason.</p>
1.76      dholland  394:         <p>When the pullup request(s) have not yet been sent
                    395:           (perhaps because they are complicated) the state should be
                    396:           set to <code class="code">needs-pullups</code> to draw this fact to the
                    397:           attention of passersby.</p>
1.48      jnemeth   398:       </li>
1.54      spz       399: <li class="listitem">
1.76      dholland  400:         <p>Once the PR submitter confirms that the fix works, and
                    401:          all pullup requests have been issued and completed, the PR
1.35      hubertf   402:          can be <code class="code">closed</code>.</p>
                    403:       </li>
                    404: </ol></div>
                    405:     <p>At each step of the PR handling process, make sure that
1.47      dsieger   406:       feedback and other analysis and commentary is <a class="ulink" href="../support/send-pr.html#appending" target="_top">appended to the PR</a>
1.35      hubertf   407:       by using a proper E-mail subject line and making sure that the
                    408:       messages are copied to
1.47      dsieger   409:       <code class="email">&lt;<a class="email" href="mailto:gnats-bugs@NetBSD.org">gnats-bugs@NetBSD.org</a>&gt;</code>. Having a complete record
1.35      hubertf   410:       of information about the PR is valuable both while hunting down
                    411:       the bug and for future system maintenance.</p>
                    412:     <p>If at all possible, it is important to get any fix committed
1.47      dsieger   413:       to the CVS trunk <a class="ulink" href="releng/pullups.html" target="_top">pulled
                    414:       up</a> by <a class="ulink" href="releng/" target="_top">NetBSD Release
1.35      hubertf   415:       Engineering</a> to the "-release" branch, so that people who
                    416:       are tracking that branch can get the fix right away rather than
                    417:       waiting for the next major release of NetBSD. This also makes it
                    418:       possible for the next point release of NetBSD to have the
                    419:       fix.</p>
                    420:     <p>The NetBSD Community is a whole lot of very smart, and very
                    421:       experienced people. If you're having trouble analyzing a problem
1.47      dsieger   422:       report, ask questions in the appropriate <a class="ulink" href="../mailinglists/" target="_top">mailing list</a>; more than likely,
1.35      hubertf   423:       someone will be able to help.</p>
                    424:   </div>
                    425: 
1.61      tron      426: <div class="sect4">
1.35      hubertf   427: <div class="titlepage"><div><div><h5 class="title">
                    428: <a name="otherways"></a>Other Ways Things Get Done</h5></div></div></div>
                    429: 
                    430: 
                    431: <p>The Ideal Process was described above. That's not the only way
                    432:   that problem reports get handled. All of the principal people
                    433:   involved in NetBSD are pretty busy, and can't devote full attention
                    434:   to this project. As such, if you see a PR that you can solve that
                    435:   hasn't been attended to yet, go claim it by setting yourself as the
1.47      dsieger   436:   Responsible Person with <span class="command"><strong>edit-pr</strong></span>, and solve
1.35      hubertf   437:   it.</p>
                    438: 
                    439: <p>Even if you don't feel qualified to hack the code yourself, if
                    440:   you can offer a test case or other information, send it along to
1.47      dsieger   441:   GNATS to be <a class="ulink" href="../support/send-pr.html#appending" target="_top">appended to
1.54      spz       442:   the PR</a>. <span class="quote">&#8220;<span class="quote">Many hands make light work.</span>&#8221;</span></p>
1.35      hubertf   443: 
                    444: <p>Some problem reports are so trivial that the fix is obvious (or
                    445:   perhaps the fix was provided by the submitter), that they go directly
                    446:   from <code class="code">open</code> to <code class="code">closed</code> immediately after the fix is
                    447:   committed.</p>
                    448: 
                    449: <p>If for some reason you find that you're unable to finish
                    450:   handling the PR, reset the <code class="code">&gt;Responsible:</code> field to
                    451:   whoever had responsibility before you took the PR over.  Don't
                    452:   prevent others from making progress on the PR because they think
                    453:   you're taking care of it.</p>
                    454: 
                    455: <p>As long as you're marked as the Responsible Person for a PR,
                    456:   you'll receive a monthly E-mail reminder about it. Use those
                    457:   reminders to drive you to review PRs and put them into their correct
                    458:   states as time passes.</p>
                    459: 
                    460: <p>When a PR is in <code class="code">feedback</code> state, the PR submitter gets an
                    461:   E-mail monthly reminder at the same time as the Responsible Persons
                    462:   do, to prompt or prod them into responding. Generally, if there
                    463:   has been no response for more than three months (three reminder
                    464:   cycles), it's pretty safe to assume that the submitter is gone or
                    465:   no longer cares.  At that point, whether to close the PR becomes
                    466:   a judgement call for the Responsible Person - how serious is it?
                    467:   Should it be solved without further input from the Submitter?</p>
                    468: 
                    469: <p>The other way we use the GNATS PR database is to keep track of
                    470:   problems which are waiting for larger issues to be solved. The
1.47      dsieger   471:   oldest PR in the database at this writing, <a class="ulink" href="http://www.NetBSD.org/cgi-bin/query-pr-single.pl?number=13" target="_top">lib/13</a>
1.35      hubertf   472:   (yes, of course it would be 13!) begs the entire
                    473:   internationalization of the NetBSD system. I18N is a hard problem
                    474:   that requires a wholesale overhaul of the system, which is why that
                    475:   PR is still open after seven years. This doesn't mean we'll never
                    476:   solve it; just that it isn't as critical as some other problems
                    477:   reported in the database.</p>
                    478: 
                    479: <p>In effect, this usage of the GNATS PR database is as a long-term
                    480:   project tracking system.</p>
                    481: </div>
                    482: 
                    483: <h4 class="title">
                    484: <a name="priorities"></a> Priorities, Severities, and Releases (<a href="#top">top</a>)
                    485:   </h4>
                    486: 
                    487: <p>In an ideal world, the GNATS PR database would be empty, we'd
                    488:   release perfect software, and Microsoft would be a shadow of its
                    489:   current self.</p>
                    490: 
                    491: <p>The <code class="code">&gt;Priority:</code> field in the PR reflects this ideal,
                    492:   in that <code class="code">high</code> priority is supposed to be fixed immediately;
                    493:   <code class="code">medium</code> is supposed to be resolved before the next release
                    494:   of NetBSD (major or minor?), and <code class="code">low</code> priority gets solved
1.54      spz       495:   <span class="quote">&#8220;<span class="quote">eventually</span>&#8221;</span>.</p>
1.35      hubertf   496: 
                    497: <p>In practice, PR resolution is dependent on the right mix of
                    498:   submitter interest, developer interest, problem reproduceability,
                    499:   hardware availability, and good timing. If any of the required
                    500:   elements is missing from the mix, the PR will sit.</p>
                    501: 
                    502: <p>If we were really diligent about PRs, we would adjust the priority
                    503:   of each PR to reflect its actual importance, and probability of
                    504:   getting fixed according to the definitions. Unfortunately, that
                    505:   requires an overall evaluation of Release Engineering goals and
                    506:   targets and all PRs relative to each other, which is difficult for
                    507:   a dispersed group to do in an organized fashion.</p>
                    508: 
                    509: <p>In contrast, the <code class="code">&gt;Severity:</code> field is really an
                    510:   expression of the amount of pain the user is going through with the
                    511:   problem being reported, and it's something we really shouldn't
                    512:   adjust without careful consideration.</p>
                    513: 
                    514: <p>The proper procedure would be to review all PRs in the database
                    515:   at each release point, to decide on a per-PR basis whether to
1.54      spz       516:   <span class="quote">&#8220;<span class="quote">fix now</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">fix later</span>&#8221;</span>,
                    517:   <span class="quote">&#8220;<span class="quote">suspend</span>&#8221;</span> and adjust priorities. Perhaps one day we'll
1.35      hubertf   518:   have the resources and manpower for that.</p>
                    519: 
                    520: 
                    521: <h4 class="title">
                    522: <a name="remotegnats"></a>Remote GNATS Operations (<a href="#top">top</a>)
                    523:   </h4>
1.16      fair      524: 
1.35      hubertf   525: <p>For people who find logging into a remote host tedious, the
                    526:   following csh aliases might be useful:</p>
1.16      fair      527: 
1.35      hubertf   528: <pre class="programlisting">
1.26      keihan    529: alias query-pr  'ssh gnats.NetBSD.org query-pr --full \!* | tee pr-\!*'
                    530: alias edit-pr   ssh -t gnats.NetBSD.org edit-pr
1.35      hubertf   531: </pre>
1.39      dsieger   532: <hr>Back to  <em><a href="./">NetBSD Developer Documentation</a></em>
                    533: </div></div></div>
                    534: <div class="navfoot"></div>
1.51      mishka    535: <div id="footer"><div id="footerContent"><center>
1.73      maya      536: <span class="footfeed"><a href="//www.NetBSD.org/cgi-bin/feedback.cgi">
1.39      dsieger   537:          Contact</a> |
1.46      kano      538:       </span><span class="footcopy"><a href="../about/disclaimer.html">
1.39      dsieger   539:       Disclaimer</a> |
                    540: 
1.69      snj       541:       <span class="copyright">Copyright © 1994-2017 The NetBSD Foundation, Inc. </span>ALL RIGHTS RESERVED.<br>NetBSD<sup>®</sup> is a registered trademark of The NetBSD
1.39      dsieger   542:        Foundation, Inc.</span>
1.51      mishka    543: </center></div></div>
1.35      hubertf   544: </div></body>
1.1       hubertf   545: </html>

CVSweb <webmaster@jp.NetBSD.org>