mirror of
https://github.com/boostorg/website.git
synced 2026-01-30 20:32:16 +00:00
149 lines
6.1 KiB
HTML
149 lines
6.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
<head>
|
|
<title>Bugs</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
|
|
<link rel="icon" href="/favicon.ico" type="image/ico" />
|
|
<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>
|
|
|
|
<body>
|
|
<div id="heading">
|
|
<!--#include virtual="/common/heading.html" -->
|
|
</div>
|
|
|
|
<div id="body">
|
|
<div id="body-inner">
|
|
<div id="content">
|
|
<div class="section" id="intro">
|
|
<div class="section-0">
|
|
<div class="section-title">
|
|
<h1>What to do about Boost bugs</h1>
|
|
</div>
|
|
|
|
<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>
|
|
|
|
<li>If you are a Boost user, or a Boost developer that doesn't
|
|
have subversion write access:
|
|
|
|
<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>:
|
|
|
|
<ol>
|
|
<li>Download the latest version of
|
|
<code>intentional_bug.hpp</code> from subversion.</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>
|
|
</ol>
|
|
</li>
|
|
</ol>
|
|
</li>
|
|
|
|
<li>If you are a Boost developer, and you have subversion write
|
|
access:
|
|
|
|
<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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="sidebar">
|
|
<!--#include virtual="/common/sidebar-common.html" -->
|
|
<!--#include virtual="/common/sidebar-support.html" -->
|
|
</div>
|
|
|
|
<div class="clear"></div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="footer">
|
|
<div id="footer-left">
|
|
<div id="revised">
|
|
<p>Revised $Date: 2007-10-22 22:55:52 +0100 (Mon, 22 Oct 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="footer-right">
|
|
<!--#include virtual="/common/footer-banners.html" -->
|
|
</div>
|
|
|
|
<div class="clear"></div>
|
|
</div>
|
|
</body>
|
|
</html>
|