| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head> |
|---|
| 2 | <meta http-equiv="Content-Language" content="en-us"> |
|---|
| 3 | |
|---|
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> |
|---|
| 5 | |
|---|
| 6 | <meta name="GENERATOR" content="Microsoft FrontPage 5.0"> |
|---|
| 7 | |
|---|
| 8 | <meta name="ProgId" content="FrontPage.Editor.Document"> |
|---|
| 9 | <title>Bugs</title> |
|---|
| 10 | </head> |
|---|
| 11 | |
|---|
| 12 | |
|---|
| 13 | <body bgcolor="#ffffff" text="#000000"> |
|---|
| 14 | |
|---|
| 15 | <table border="1" bgcolor="#007f7f" cellpadding="2"> |
|---|
| 16 | |
|---|
| 17 | <tbody><tr> |
|---|
| 18 | <td bgcolor="#ffffff"> |
|---|
| 19 | <img src="../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td> |
|---|
| 20 | <td><a href="../index.htm"><font face="Arial" color="#ffffff"><big>Home</big></font></a></td> |
|---|
| 21 | <td><a href="../libs/libraries.htm"><font face="Arial" color="#ffffff"><big> |
|---|
| 22 | Libraries</big></font></a></td> |
|---|
| 23 | <td><a href="../people/people.htm"><font face="Arial" color="#ffffff"><big> |
|---|
| 24 | People</big></font></a></td> |
|---|
| 25 | <td><a href="faq.htm"><font face="Arial" color="#ffffff"><big>FAQ</big></font></a></td> |
|---|
| 26 | <td><a href="index.htm"><font face="Arial" color="#ffffff"><big>More</big></font></a></td> |
|---|
| 27 | </tr> |
|---|
| 28 | </tbody> |
|---|
| 29 | </table> |
|---|
| 30 | |
|---|
| 31 | <h1>What to do about Boost bugs</h1> |
|---|
| 32 | |
|---|
| 33 | <ol> |
|---|
| 34 | |
|---|
| 35 | <li>Make sure the bug isn't already fixed in the latest sources. The most |
|---|
| 36 | recent version of everything on the Boost web site is available from |
|---|
| 37 | the <a href="http://www.boost.org/more/getting_started.html#CVS">boost public |
|---|
| 38 | CVS repository</a>.<br> |
|---|
| 39 | <br> |
|---|
| 40 | </li> |
|---|
| 41 | <li>If you are a Boost user, or a Boost developer that doesn't have a CVS |
|---|
| 42 | write access: <br> |
|---|
| 43 | <br> |
|---|
| 44 | <ol> |
|---|
| 45 | <li>Submit a bug report to either |
|---|
| 46 | <a href="http://www.boost.org/more/mailing_lists.htm#users">boost-users list</a>, |
|---|
| 47 | <a href="http://www.boost.org/more/mailing_lists.htm#main">boost mailing |
|---|
| 48 | list</a>, or our <a href="http://svn.boost.org/trac/boost/report">bug |
|---|
| 49 | tracking facility</a>; submitting it to either of the mailing |
|---|
| 50 | lists is a preferred way - because many of the Boost developers read the |
|---|
| 51 | lists on a daily basis, this way you are likely to get a quicker response, |
|---|
| 52 | and the discussions that often arise there from (possible) bug reports are |
|---|
| 53 | quite interesting and educational as well;<br> |
|---|
| 54 | <br> |
|---|
| 55 | </li> |
|---|
| 56 | <li>If you have a proposed patch to the code, post it along with your bug |
|---|
| 57 | report, preferably in the <em>unified diffs</em> format (<code>cvs diff -du</code>); |
|---|
| 58 | if you can, send a patch relative to the current CVS state. A canonical |
|---|
| 59 | example of creating a patch file follows (let's assume that you've found |
|---|
| 60 | a bug in the file <code>intentional_bug.hpp</code>:<br> |
|---|
| 61 | <br> |
|---|
| 62 | <ol> |
|---|
| 63 | <li>Download the latest version of <code>intentional_bug.hpp</code> from CVS.</li> |
|---|
| 64 | <li>Make sure that the bug is still present in the code.</li> |
|---|
| 65 | <li>Copy the file <code>intentional_bug.hpp</code> to a file called <code>intentional_bug.hpp.orig</code>.</li> |
|---|
| 66 | <li>Apply your changes to <code>intentional_bug.hpp</code>.</li> |
|---|
| 67 | <li>Run "<code>diff -du intentional_bug.hpp.orig intentional_bug.hpp > intentional_bug.hpp.patch</code>" from the command prompt.</li> |
|---|
| 68 | <li>Submit the patch file together with an explanation of the bug |
|---|
| 69 | and the proposed fix; and don't forget to include the word <b>patch</b> or <b>bug</b> |
|---|
| 70 | 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> |
|---|
| 71 | <br> |
|---|
| 72 | </li> |
|---|
| 73 | </ol> |
|---|
| 74 | |
|---|
| 75 | </li> |
|---|
| 76 | |
|---|
| 77 | </ol> |
|---|
| 78 | </li> |
|---|
| 79 | <li>If you are a Boost developer, and you have a CVS write access: <br> |
|---|
| 80 | <br> |
|---|
| 81 | <ol> |
|---|
| 82 | <li>If the bug is trivial (e.g. misspelled name, missed <code>typename</code>, |
|---|
| 83 | etc.), and you are willing to make a fix, either make your changes locally |
|---|
| 84 | and contact the library author(s)/maintainer(s) about it, or go ahead and |
|---|
| 85 | check the fix into CVS, but post a notification about it to the |
|---|
| 86 | <a href="http://www.boost.org/more/mailing_lists.htm#main">boost mailing |
|---|
| 87 | list</a> (if the author is not very active on the list, you also might want |
|---|
| 88 | to consider <code>cc</code>'ing him as well); <br> |
|---|
| 89 | <br> |
|---|
| 90 | </li> |
|---|
| 91 | <li>If the bug is non-trivial, and/or you don't have the time and resources to fix it, |
|---|
| 92 | submit a bug report (see p. 2 above); chances are that the maintainer(s) |
|---|
| 93 | will respond promptly and take care of the problem; <br> |
|---|
| 94 | <br> |
|---|
| 95 | </li> |
|---|
| 96 | <li>Otherwise, create a temporary branch in CVS, make your changes there, and |
|---|
| 97 | ask the library author(s)/maintainer(s) to review them; if they are ok with |
|---|
| 98 | the new code, either you or they can integrate the fixes into the main |
|---|
| 99 | trunk. </li> |
|---|
| 100 | </ol> |
|---|
| 101 | </li> |
|---|
| 102 | </ol> |
|---|
| 103 | |
|---|
| 104 | <hr> |
|---|
| 105 | <p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->18 January, 2002<!--webbot bot="Timestamp" i-checksum="38453" endspan --> |
|---|
| 106 | </p> |
|---|
| 107 | |
|---|
| 108 | <p>© Copyright <a href="../people/aleksey_gurtovoy.htm">Aleksey Gurtovoy</a> |
|---|
| 109 | 2002</p> |
|---|
| 110 | <p> Distributed under the Boost Software License, Version 1.0. |
|---|
| 111 | (See accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or |
|---|
| 112 | copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>) |
|---|
| 113 | </p> |
|---|
| 114 | |
|---|
| 115 | <br> |
|---|
| 116 | |
|---|
| 117 | </body></html> |
|---|
| 118 | |
|---|
