more/bugs.htm
2006-12-11 05:16:00 +00:00

119 lines
5.0 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head>
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<title>Bugs</title>
</head>
<body bgcolor="#ffffff" text="#000000">
<table border="1" bgcolor="#007f7f" cellpadding="2">
<tbody><tr>
<td bgcolor="#ffffff">
<img src="../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td>
<td><a href="../index.htm"><font face="Arial" color="#ffffff"><big>Home</big></font></a></td>
<td><a href="../libs/libraries.htm"><font face="Arial" color="#ffffff"><big>
Libraries</big></font></a></td>
<td><a href="../people/people.htm"><font face="Arial" color="#ffffff"><big>
People</big></font></a></td>
<td><a href="faq.htm"><font face="Arial" color="#ffffff"><big>FAQ</big></font></a></td>
<td><a href="index.htm"><font face="Arial" color="#ffffff"><big>More</big></font></a></td>
</tr>
</tbody>
</table>
<h1>What to do about 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://www.boost.org/more/getting_started.html#CVS">boost public
CVS repository</a>.<br>
<br>
</li>
<li>If you are a Boost user, or a Boost developer that doesn't have a CVS
write access: <br>
<br>
<ol>
<li>Submit a bug report to either
<a href="http://www.boost.org/more/mailing_lists.htm#users">boost-users list</a>,
<a href="http://www.boost.org/more/mailing_lists.htm#main">boost mailing
list</a>, or our <a href="http://sourceforge.net/tracker/?group_id=7586">bug
tracking facility</a> at SourceForge; 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;<br>
<br>
</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 CVS 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>:<br>
<br>
<ol>
<li>Download the latest version of <code>intentional_bug.hpp</code> from CVS.</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 &gt; 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 <b>patch</b> or <b>bug</b>
in the subject if you're submitting to the <a href="http://www.boost.org/more/mailing_lists.htm#main">boost mailing list</a>.<br>
<br>
</li>
</ol>
</li>
</ol>
</li>
<li>If you are a Boost developer, and you have a CVS write access: <br>
<br>
<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 CVS, but post a notification about it to the
<a href="http://www.boost.org/more/mailing_lists.htm#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); <br>
<br>
</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; <br>
<br>
</li>
<li>Otherwise, create a temporary branch in CVS, 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>
<hr>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->18 January, 2002<!--webbot bot="Timestamp" i-checksum="38453" endspan -->
</p>
<p><EFBFBD> Copyright <a href="../people/aleksey_gurtovoy.htm">Aleksey Gurtovoy</a>
2002</p>
<p> Distributed under the Boost Software License, Version 1.0.
(See accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)
</p>
<br>
</body></html>