summaryrefslogtreecommitdiff
path: root/tools/regression/doc/instructions.html
blob: bc74cc6b47b794223496ee568a3760348b8deabd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>Running Boost Regression Tests</title>
<link rel="stylesheet" type="text/css" href="../../../doc/html/minimal.css">
</head>

<body>

<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="831">
  <tr>
    <td width="277">
<a href="../../../../index.htm">
<img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" width="277" height="86" border="0"></a></td>
    <td width="531" align="middle">
    <font size="7">Running Boost Regression Tests</font>
    </td>
  </tr>
</table>

<h2>Requirements</h2>
<ul>
  <li>Python 2.3 or later.<br>
&nbsp;</li>
  <li>Subversion 1.4 or later.<br>
&nbsp;</li>
  <li>At least 5 gigabytes of disk space per compiler to be tested.</li>
</ul>
<h2>Step by step instructions</h2>
<ol>
  <li>Create a new directory for the branch you want to test.<br>
&nbsp;</li>
  <li>Download the
  <a href="http://svn.boost.org/svn/boost/trunk/tools/regression/src/run.py">
  run.py</a> script into that directory.<br>
&nbsp;</li>
  <li>Run &quot;<code>python run.py [options] [commands]</code>&quot;.</li>
</ol>
<dl>
  <dd>
  <pre>commands: cleanup, collect-logs, get-source, get-tools, patch,
regression, setup, show-revision, test, test-clean, test-process,
test-run, update-source, upload-logs

options:
   -h, --help            show this help message and exit
   --runner=RUNNER       runner ID (e.g. 'Metacomm')
   --comment=COMMENT     an HTML comment file to be inserted in the
                         reports
   --tag=TAG             the tag for the results
   --toolsets=TOOLSETS   comma-separated list of toolsets to test with
   --incremental         do incremental run (do not remove previous
                         binaries)
   --timeout=TIMEOUT     specifies the timeout, in minutes, for a single
                         test run/compilation
   --bjam-options=BJAM_OPTIONS
                         options to pass to the regression test
   --bjam-toolset=BJAM_TOOLSET
                         bootstrap toolset for 'bjam' executable
   --pjl-toolset=PJL_TOOLSET
                         bootstrap toolset for 'process_jam_log'
                         executable
   --platform=PLATFORM
   --user=USER           Boost SVN user ID
   --local=LOCAL         the name of the boost tarball
   --force-update=FORCE_UPDATE
                         do an SVN update (if applicable) instead of a
                         clean checkout, even when performing a full run
   --have-source=HAVE_SOURCE
                         do neither a tarball download nor an SVN update;
                         used primarily for testing script changes
   --proxy=PROXY         HTTP proxy server address and port
                         (e.g.'<a rel="nofollow" href="http://www.someproxy.com:3128'" target="_top">http://www.someproxy.com:3128'</a>)
   --ftp-proxy=FTP_PROXY
                         FTP proxy server (e.g. 'ftpproxy')
   --dart-server=DART_SERVER
                         the dart server to send results to
   --debug-level=DEBUG_LEVEL
                         debugging level; controls the amount of
                         debugging output printed
   --send-bjam-log       send full bjam log of the regression run
   --mail=MAIL           email address to send run notification to
   --smtp-login=SMTP_LOGIN
                         STMP server address/login information, in the
                         following form:
                         &lt;user&gt;:&lt;password&gt;@&lt;host&gt;[:&lt;port&gt;]
   --skip-tests=SKIP_TESTS
                         do not run bjam; used for testing script changes</pre>
  </dd>
</dl>
<p>To test trunk use &quot;<code>--tag=trunk</code>&quot; (the default), and to test the 
release use &quot;<code>--tag=branches/release</code>&quot;. Or substitute any Boost tree 
of your choice.</p>

<hr>

<p>© Copyright Rene Rivera, 2007<br>
Distributed under the Boost Software License, Version 1.0. See
<a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a></p>

<p>Revised 
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->November 23, 2007<!--webbot bot="Timestamp" endspan i-checksum="39587" --> </font>
</p>

</body>