|
|
Boost-Commit : |
From: dave_at_[hidden]
Date: 2007-11-28 13:20:31
Author: dave
Date: 2007-11-28 13:20:30 EST (Wed, 28 Nov 2007)
New Revision: 41438
URL: http://svn.boost.org/trac/boost/changeset/41438
Log:
Reworked bug reporting instructions to stress the tracker
Text files modified:
website/public_html/beta/support/bugs.html | 229 ++++++++++++++++++++++-----------------
1 files changed, 126 insertions(+), 103 deletions(-)
Modified: website/public_html/beta/support/bugs.html
==============================================================================
--- website/public_html/beta/support/bugs.html (original)
+++ website/public_html/beta/support/bugs.html 2007-11-28 13:20:30 EST (Wed, 28 Nov 2007)
@@ -3,10 +3,14 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
+
<title>Bugs</title>
- <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="icon" href="/favicon.ico" type="image/ico" />
- <link rel="stylesheet" type="text/css" href="/style/section-support.css" />
+ <link rel="stylesheet" type="text/css" href=
+ "../style/section-support.css" />
<!--[if IE]> <style type="text/css"> body { behavior: url(/style/csshover.htc); } </style> <![endif]-->
</head>
@@ -21,128 +25,147 @@
<div class="section" id="intro">
<div class="section-0">
<div class="section-title">
- <h1>What to do about Boost bugs</h1>
- </div>
+ <h1>Reporting Boost bugs</h1>
- <ol>
- <li>Make sure the bug isn't already fixed in the latest
- sources. The most recent version of everything on the Boost web
- site is available from the <a href=
- "http://svn.boost.org/trac/boost/wiki/BoostSubversion" class=
- "external">boost public subversion repository</a>.</li>
+ <div>
+ <ol>
+ <li>If you know where to look in the source code, make sure
+ the bug isn't already fixed in the latest sources. The most
+ recent version of everything on the Boost web site is
+ available from the <a href=
+ "http://svn.boost.org/trac/boost/wiki/BoostSubversion"
+ class="external">boost public subversion
+ repository</a>.</li>
+
+ <li><a href=
+ "http://svn.boost.org/trac/boost/search?ticket=on">search
+ the bug database</a> to make sure we don't already know
+ about the bug. If we do, you can add further information to
+ an existing bug ticket.</li>
+
+ <li>If you have a userid on the Boost Trac server, please
+ <a href="http://svn.boost.org/trac/boost/login">log
+ in</a>.</li>
+
+ <li><strong>Even if you don't have a userid</strong>, visit
+ <a href="http://svn.boost.org/trac/boost/settings">the
+ settings page</a> to enter or confirm an email address at
+ which you can be reached. Most bug reports require some
+ interaction with the reporter, and if we can't follow up
+ with you, chances are good that your efforts at reporting
+ the bug will be wasted.</li>
+
+ <li>
+ <p><a href=
+ "http://svn.boost.org/trac/boost/newticket">Create a new
+ ticket</a> in the bug tracker.</p>
+
+ <p>If possible,</p>
+
+ <ul>
+ <li>Fill out all the fields completely, especially the
+ “component†field that identifies the library. That
+ will help ensure your report is noticed by the
+ appropriate developers.</li>
+
+ <li>Attach a <em>minimal</em> and <em>complete</em>
+ program that reproduces the problem. Aside from helping
+ the library maintainer fix the problem, you may find
+ the bug in your own code, which can avoid a costly
+ delay waiting for a response.</li>
+ </ul>
+ </li>
+ </ol>
+ </div>
- <li>If you are a Boost user, or a Boost developer that doesn't
- have subversion write access:
+ <h2>If You Have a Fix for the Bug</h2>
- <ol>
- <li>Submit a bug report to either <a href=
- "/community/groups.html#users">boost-users list</a>,
- <a href="/community/groups.html#main">boost mailing
- list</a>, or our <a href=
- "http://svn.boost.org/trac/boost/report" class=
- "external">bug tracking facility</a>; submitting it to
- either of the mailing lists is a preferred way - because
- many of the Boost developers read the lists on a daily
- basis, this way you are likely to get a quicker response,
- and the discussions that often arise there from (possible)
- bug reports are quite interesting and educational as
- well;</li>
-
- <li>If you have a proposed patch to the code, post it along
- with your bug report, preferably in the <em>unified
- diffs</em> format (<code>cvs diff -du</code>); if you can,
- send a patch relative to the current subversion state. A
- canonical example of creating a patch file follows (let's
- assume that you've found a bug in the file
- <code>intentional_bug.hpp</code>:
+ <div>
+ After completing the steps above,
+
+ <ul>
+ <li>
+ <p>If you <em>are not</em> a boost developer, attach a
+ patch for the code in the <em>unified diff</em> format,
+ along with an explanation of your proposed fix. If you
+ can, make a patch relative to the current subversion
+ state.</p>
+
+ <p>To create a patch file:</p>
<ol>
- <li>Download the latest version of
- <code>intentional_bug.hpp</code> from subversion.</li>
+ <li>Get the latest version of the files you're fixing
+ <a href="http://svn.boost.org/svn/boost">directly from
+ subversion</a> or from the <a href=
+ "http://svn.boost.org/trac/boost/browser/trunk">Trac
+ repository browser</a>.</li>
<li>Make sure that the bug is still present in the
code.</li>
- <li>Copy the file <code>intentional_bug.hpp</code> to a
- file called <code>intentional_bug.hpp.orig</code>.</li>
-
- <li>Apply your changes to
- <code>intentional_bug.hpp</code>.</li>
-
- <li>Run "<code>diff -du intentional_bug.hpp.orig
- intentional_bug.hpp >
- intentional_bug.hpp.patch</code>" from the command
- prompt.</li>
-
- <li>Submit the patch file together with an explanation
- of the bug and the proposed fix; and don't forget to
- include the word <strong>patch</strong> or
- <strong>bug</strong> in the subject if you're
- submitting to the <a href=
- "/community/groups.html#main">boost mailing
- list</a>.</li>
+ <li>If you got your code directly from subversion, make
+ your fixes, and then execute “<code>svn diff >
+ <var>patchfile</var>.patch</code>†from a directory in
+ your working copy that contains all your changes.</li>
+
+ <li>Otherwise, make a full recursive copy of a
+ directory containing the files in question, make your
+ fixes in the new copy, then execute “<code>diff -dur
+ <var>olddirectory</var> <var>newdirectory</var> >
+ <var>patchfile</var>.patch</code></li>
</ol>
</li>
- </ol>
- </li>
- <li>If you are a Boost developer, and you have subversion write
- access:
+ <li>If you <em>are</em> a Boost developer,
- <ol>
- <li>If the bug is trivial (e.g. misspelled name, missed
- <code>typename</code>, etc.), and you are willing to make a
- fix, either make your changes locally and contact the
- library author(s)/maintainer(s) about it, or go ahead and
- check the fix into subversion, but post a notification
- about it to the <a href="/community/groups.html#main">boost
- mailing list</a> (if the author is not very active on the
- list, you also might want to consider <code>cc</code>'ing
- him as well);</li>
-
- <li>If the bug is non-trivial, and/or you don't have the
- time and resources to fix it, submit a bug report (see p. 2
- above); chances are that the maintainer(s) will respond
- promptly and take care of the problem;</li>
-
- <li>Otherwise, create a temporary branch in subversion,
- make your changes there, and ask the library
- author(s)/maintainer(s) to review them; if they are ok with
- the new code, either you or they can integrate the fixes
- into the main trunk.</li>
- </ol>
- </li>
- </ol>
+ <ul>
+ <li>If the bug is trivial (e.g. misspelled name, missed
+ <code>typename</code>, etc.), you can assign the ticket
+ to yourself and check the fix into subversion,
+ inserting “fixes #<var>ticket number</var>†in the log
+ comment to automatically close the ticket. However,
+ please keep the library's maintainer in the loop by
+ adding his Trac userid or email address to the ticket's
+ Cc: field.</li>
+
+ <li>Otherwise, create a temporary branch in subversion,
+ make your changes there, and ask the library
+ author(s)/maintainer(s) to review them; if approve the
+ new code, either you or they can integrate the fixes
+ into the main trunk.</li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
</div>
</div>
- </div>
- <div id="sidebar">
- <!--#include virtual="/common/sidebar-common.html" -->
- <!--#include virtual="/common/sidebar-support.html" -->
+ <div id="sidebar">
+ <!--#include virtual="/common/sidebar-common.html" -->
+ <!--#include virtual="/common/sidebar-support.html" -->
+ </div>
</div>
- <div class="clear"></div>
- </div>
- </div>
-
- <div id="footer">
- <div id="footer-left">
- <div id="revised">
- <p>Revised $Date$</p>
- </div>
+ <div id="footer">
+ <div id="footer-left">
+ <div id="revised">
+ <p>Revised $Date: 2007-11-16 13:46:36 -0500 (Fri, 16 Nov 2007)
+ $</p>
+ </div>
- <div id="copyright">
- <p>Copyright <a href="/users/people/aleksey_gurtovoy.html">Aleksey
- Gurtovoy</a> 2002</p>
- </div><!--#include virtual="/common/footer-license.html" -->
- </div>
+ <div id="copyright">
+ <p>Copyright <a href=
+ "/users/people/aleksey_gurtovoy.html">Aleksey Gurtovoy</a>
+ 2002</p>
+ </div><!--#include virtual="/common/footer-license.html" -->
+ </div>
- <div id="footer-right">
- <!--#include virtual="/common/footer-banners.html" -->
+ <div id="footer-right">
+ <!--#include virtual="/common/footer-banners.html" -->
+ </div>
+ </div>
</div>
-
- <div class="clear"></div>
</div>
</body>
</html>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk