summaryrefslogtreecommitdiff
path: root/tools/regression/doc/reports.html
blob: 94a581dfaa8a092786bbbfe38532b597980dfb1a (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
<html>

<head>
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Running Regression Reports</title>
</head>

<body>
  <h1><img src="../../../boost.png" alt="boost.png (6897 bytes)" align=
  "center" width="277" height="86" /> Running Regression Test Reports</h1>

  <h2>Introduction</h2>
  <p>After initial setup, a script is run that:</p>
  <h2>Prerequisites</h2>
  <ul>
    <li><b>Linux</b>. In theory it should be possible to run the run the reports 
    on most modern operating system, including OS X and Windows, but all testing 
    and current use has been on Linux.</li>
    <li><b>Git</b> installed.</li>
    <li>A C++ compiler installed.</li>
  </ul>
  <h2>Initial setup</h2>
  <p>Run once only:</p>
  <blockquote>
    <pre>cd ~                   # or some other directory of your choice
mkdir boost-reports    # or some other name of your choice
cd boost-reports
mkdir trunk            # TODO: change to develop | master | ?
git clone --recursive git@github.com:boostorg/boost.git boost
pushd boost
git checkout develop
git pull
git submodule foreach &#39;git  
./bootstrap.sh
./b2 headers</pre>
  </blockquote>
  <h2>Build report generation program <code>boost_report</code></h2>
  <p>This only has to be done when there is a change to the report generation 
  program.</p>
  <blockquote>
    <pre>
pushd ~/modular-boost/tools/regression/build
b2 boost_report
# find location of exectuable, then:
mv bin/gcc-4.8/release/boost_report ~/boost-reports
popd</pre>
  </blockquote>
  <h2>Run reports</h2>
  <ul>
    <li>Updates its internal procedures from the git public repository.</li>
    <li>Downloads current result zip files from an ftp server.</li>
    <li>Generates the HTML reports. (Now using a C++ program that is much faster 
    than the old XSLT process.)</li>
    <li>Uploads a zip file containing the reports to a web server.</li>
  </ul>
  <p>To run:</p>
  <blockquote>
    <pre>boost/tools/regression/xsl_reports/build_results.sh develop</pre>
  </blockquote>
  <h2>To Do</h2>
  <ul>
    <li>build_results.sh should take care of updating boost_report if needed.</li>
    <li>Avoid the clone --recursive; just install the core libraries (for some 
    definition of core libraries).</li>
    <li>Add install options to tools/regression/build/Jamroot.jam?</li>
  </ul>
  <p>&nbsp;</p>
  <hr>

  <p><font size="2">Revised
  <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->09 January 2014<!--webbot bot="Timestamp" endspan i-checksum="32406" --></font></p>

  <p><font size="2">Copyright Beman Dawes 2014.</font></p>

  <p><font size="2">Distributed under the 
  <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</font></p>
  <p>&nbsp;</p>

</body>

</html>