|
|
@@ -248,16 +248,16 @@ ul.auto-toc {
|
|
|
<body>
|
|
|
<div class="document" id="running-boost-regression-tests">
|
|
|
<h1 class="title">Running Boost Regression Tests</h1>
|
|
|
-<div class="section" id="requirements">
|
|
|
-<h2><a name="requirements">Requirements</a></h2>
|
|
|
+<div class="section">
|
|
|
+<h1><a id="requirements" name="requirements">Requirements</a></h1>
|
|
|
<ul class="simple">
|
|
|
<li>Python 2.3 or higher</li>
|
|
|
<li>Some spare disk space (~5 Gb per each tested compiler)</li>
|
|
|
</ul>
|
|
|
<p>That's it! You don't even need a CVS client installed.</p>
|
|
|
</div>
|
|
|
-<div class="section" id="installation">
|
|
|
-<h2><a name="installation">Installation</a></h2>
|
|
|
+<div class="section">
|
|
|
+<h1><a id="installation" name="installation">Installation</a></h1>
|
|
|
<ul class="simple">
|
|
|
<li>Download regression driver <tt class="docutils literal"><span class="pre">regression.py</span></tt> from <a class="reference" href="http://cvs.sourceforge.net/viewcvs.py/*checkout*/boost/boost/tools/regression/xsl_reports/runner/regression.py">here</a> (<a class="reference" href="http://tinyurl.com/4fp4g">http://tinyurl.com/4fp4g</a>)
|
|
|
and put it in the directory where you want all the regression
|
|
|
@@ -274,8 +274,8 @@ my_boost_regressions/
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
-<div class="section" id="running-tests">
|
|
|
-<h2><a name="running-tests">Running tests</a></h2>
|
|
|
+<div class="section">
|
|
|
+<h1><a id="running-tests" name="running-tests">Running tests</a></h1>
|
|
|
<p>To start a regression run, simply run <tt class="docutils literal"><span class="pre">regression.py</span></tt> providing it with the following
|
|
|
two arguments:</p>
|
|
|
<ul class="simple">
|
|
|
@@ -296,8 +296,8 @@ parameters through the <tt class="docutils literal"><span class="pre">--proxy</s
|
|
|
python regression.py ... <strong>--proxy=http://www.someproxy.com:3128</strong>
|
|
|
</pre>
|
|
|
</div>
|
|
|
-<div class="section" id="details">
|
|
|
-<h2><a name="details">Details</a></h2>
|
|
|
+<div class="section">
|
|
|
+<h1><a id="details" name="details">Details</a></h1>
|
|
|
<p>The regression run procedure will:</p>
|
|
|
<ul class="simple">
|
|
|
<li>Download the most recent tarball from <a class="reference" href="http://www.meta-comm.com/engineering/boost/snapshot/">http://www.meta-comm.com/engineering/boost/snapshot/</a>,
|
|
|
@@ -312,10 +312,10 @@ Boost.Build).</li>
|
|
|
merge all submitted test runs and publish them at
|
|
|
<a class="reference" href="http://boost.sourceforge.net/regression-logs/developer">http://boost.sourceforge.net/regression-logs/developer</a>.</p>
|
|
|
</div>
|
|
|
-<div class="section" id="advanced-use">
|
|
|
-<h2><a name="advanced-use">Advanced use</a></h2>
|
|
|
-<div class="section" id="providing-detailed-information-about-your-environment">
|
|
|
-<h3><a name="providing-detailed-information-about-your-environment">Providing detailed information about your environment</a></h3>
|
|
|
+<div class="section">
|
|
|
+<h1><a id="advanced-use" name="advanced-use">Advanced use</a></h1>
|
|
|
+<div class="section">
|
|
|
+<h2><a id="providing-detailed-information-about-your-environment" name="providing-detailed-information-about-your-environment">Providing detailed information about your environment</a></h2>
|
|
|
<p>Once you have your regression results displayed in the Boost-wide
|
|
|
reports, you may consider providing a bit more information about
|
|
|
yourself and your test environment. This additional information will
|
|
|
@@ -328,16 +328,16 @@ and test schedule, by simply altering the file's content. Also, please
|
|
|
consider providing your name and email address for cases where Boost
|
|
|
developers have questions specific to your particular set of results.</p>
|
|
|
</div>
|
|
|
-<div class="section" id="incremental-runs">
|
|
|
-<h3><a name="incremental-runs">Incremental runs</a></h3>
|
|
|
+<div class="section">
|
|
|
+<h2><a id="incremental-runs" name="incremental-runs">Incremental runs</a></h2>
|
|
|
<p>You can run <tt class="docutils literal"><span class="pre">regression.py</span></tt> in incremental mode <a class="footnote-reference" href="#incremental" id="id5" name="id5">[4]</a> by simply passing
|
|
|
it an identically named command-line flag:</p>
|
|
|
<pre class="literal-block">
|
|
|
python regression.py ... <strong>--incremental</strong>
|
|
|
</pre>
|
|
|
</div>
|
|
|
-<div class="section" id="dealing-with-misbehaved-tests-compilers">
|
|
|
-<h3><a name="dealing-with-misbehaved-tests-compilers">Dealing with misbehaved tests/compilers</a></h3>
|
|
|
+<div class="section">
|
|
|
+<h2><a id="dealing-with-misbehaved-tests-compilers" name="dealing-with-misbehaved-tests-compilers">Dealing with misbehaved tests/compilers</a></h2>
|
|
|
<p>Depending on the environment/C++ runtime support library the test is compiled with,
|
|
|
a test failure/termination may cause an appearance of a dialog window, requiring
|
|
|
human intervention to proceed. Moreover, the test (or even of the compiler itself)
|
|
|
@@ -350,8 +350,8 @@ python regression.py ... <strong>--monitored</strong>
|
|
|
<p>That's it. Knowing your intentions, the script will be able to automatically deal
|
|
|
with the listed issues <a class="footnote-reference" href="#monitored" id="id6" name="id6">[5]</a>.</p>
|
|
|
</div>
|
|
|
-<div class="section" id="getting-sources-from-cvs">
|
|
|
-<h3><a name="getting-sources-from-cvs">Getting sources from CVS</a></h3>
|
|
|
+<div class="section">
|
|
|
+<h2><a id="getting-sources-from-cvs" name="getting-sources-from-cvs">Getting sources from CVS</a></h2>
|
|
|
<p>If you already have a CVS client installed and configured, you might prefer to get
|
|
|
the sources directly from the Boost CVS repository. To communicate this to the
|
|
|
script, you just need to pass it your SourceForge user ID using the <tt class="docutils literal"><span class="pre">--user</span></tt>
|
|
|
@@ -364,8 +364,8 @@ Note, though, that the files obtained this way tend to lag behind the actual CVS
|
|
|
state by several hours, sometimes up to twelve. By contrast, the tarball the script
|
|
|
downloads by default is at most one hour behind.</p>
|
|
|
</div>
|
|
|
-<div class="section" id="integration-with-a-custom-driver-script">
|
|
|
-<h3><a name="integration-with-a-custom-driver-script">Integration with a custom driver script</a></h3>
|
|
|
+<div class="section">
|
|
|
+<h2><a id="integration-with-a-custom-driver-script" name="integration-with-a-custom-driver-script">Integration with a custom driver script</a></h2>
|
|
|
<p>Even if you've already been using a custom driver script, and for some
|
|
|
reason you don't want <tt class="docutils literal"><span class="pre">regression.py</span></tt> to take over of the entire test cycle,
|
|
|
getting your regression results into <a class="reference" href="http://www.boost.org/regression-logs/developer/">Boost-wide reports</a> is still easy!</p>
|
|
|
@@ -401,14 +401,29 @@ python $BOOST_ROOT/tools/regression/xsl_reports/runner/collect_and_upload_logs.p
|
|
|
</li>
|
|
|
</ol>
|
|
|
</div>
|
|
|
+<div class="section">
|
|
|
+<h2><a id="patching-boost-sources" name="patching-boost-sources">Patching Boost sources</a></h2>
|
|
|
+<p>You might encounter an occasional need to make local modifications to
|
|
|
+the Boost codebase before running the tests, without disturbing the
|
|
|
+automatic nature of the regression process. To implement this under
|
|
|
+<tt class="docutils literal"><span class="pre">regression.py</span></tt>:</p>
|
|
|
+<ol class="arabic simple">
|
|
|
+<li>Codify applying the desired modifications to the sources
|
|
|
+located in the <tt class="docutils literal"><span class="pre">./boost</span></tt> subdirectory in a single executable
|
|
|
+script named <tt class="docutils literal"><span class="pre">patch_boost</span></tt> (<tt class="docutils literal"><span class="pre">patch_boost.bat</span></tt> on Windows).</li>
|
|
|
+<li>Place the script in the <tt class="docutils literal"><span class="pre">regression.py</span></tt> directory.</li>
|
|
|
+</ol>
|
|
|
+<p>The driver will check for the existence of the <tt class="docutils literal"><span class="pre">patch_boost</span></tt> script,
|
|
|
+and, if found, execute it after obtaining the Boost sources.</p>
|
|
|
+</div>
|
|
|
</div>
|
|
|
-<div class="section" id="feedback">
|
|
|
-<h2><a name="feedback">Feedback</a></h2>
|
|
|
+<div class="section">
|
|
|
+<h1><a id="feedback" name="feedback">Feedback</a></h1>
|
|
|
<p>Please send all comments/suggestions regarding this document and the testing procedure
|
|
|
itself to the <a class="reference" href="http://lists.boost.org/mailman/listinfo.cgi/boost-testing">Boost Testing list</a>.</p>
|
|
|
</div>
|
|
|
-<div class="section" id="notes">
|
|
|
-<h2><a name="notes">Notes</a></h2>
|
|
|
+<div class="section">
|
|
|
+<h1><a id="notes" name="notes">Notes</a></h1>
|
|
|
<table class="docutils footnote" frame="void" id="runnerid1" rules="none">
|
|
|
<colgroup><col class="label" /><col /></colgroup>
|
|
|
<tbody valign="top">
|
|
|
@@ -464,8 +479,7 @@ are running on a Windows platform. Contributions are welcome!</td></tr>
|
|
|
</div>
|
|
|
<div class="footer">
|
|
|
<hr class="footer" />
|
|
|
-<a class="reference" href="instructions.rst">View document source</a>.
|
|
|
-Generated on: 2005-08-31 14:10 UTC.
|
|
|
+Generated on: 2006-02-27 13:46 UTC.
|
|
|
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
|
|
|
|
|
|
</div>
|
Aleksey Gurtovoy