Kaynağa Gözat

integration instructions

[SVN r24141]
Aleksey Gurtovoy 22 yıl önce
ebeveyn
işleme
10e26e9a7f

+ 39 - 240
tools/regression/xsl_reports/runner/instructions.html

@@ -5,245 +5,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils 0.3.4: http://docutils.sourceforge.net/" />
 <title>Running Boost Regression Tests</title>
-<style type="text/css"><!--
-
-/*
-:Author: David Goodger
-:Contact: goodger@users.sourceforge.net
-:date: $Date$
-:version: $Revision$
-:copyright: This stylesheet has been placed in the public domain.
-
-Default cascading style sheet for the HTML output of Docutils.
-*/
-
-body {
-    background-color: #fffff5;
-}
-
-h2 {
-    text-decoration: underline;
-}
-
-.first {
-  margin-top: 0 }
-
-.last {
-  margin-bottom: 0 }
-
-a.toc-backref {
-  text-decoration: none ;
-  color: black }
-
-blockquote.epigraph {
-  margin: 2em 5em ; }
-
-dd {
-  margin-bottom: 0.5em }
-
-div.abstract {
-  margin: 2em 5em }
-
-div.abstract p.topic-title {
-  font-weight: bold ;
-  text-align: center }
-
-div.attention, div.caution, div.danger, div.error, div.hint,
-div.important, div.note, div.tip, div.warning, div.admonition {
-  margin: 2em ;
-  border: medium outset ;
-  padding: 1em }
-
-div.attention p.admonition-title, div.caution p.admonition-title,
-div.danger p.admonition-title, div.error p.admonition-title,
-div.warning p.admonition-title {
-  color: red ;
-  font-weight: bold ;
-  font-family: sans-serif }
-
-div.hint p.admonition-title, div.important p.admonition-title,
-div.note p.admonition-title, div.tip p.admonition-title,
-div.admonition p.admonition-title {
-  font-weight: bold ;
-  font-family: sans-serif }
-
-div.dedication {
-  margin: 2em 5em ;
-  text-align: center ;
-  font-style: italic }
-
-div.dedication p.topic-title {
-  font-weight: bold ;
-  font-style: normal }
-
-div.figure {
-  margin-left: 2em }
-
-div.footer, div.header {
-  font-size: smaller }
-
-div.sidebar {
-  margin-left: 1em ;
-  border: medium outset ;
-  padding: 0em 1em ;
-  background-color: #ffffee ;
-  width: 40% ;
-  float: right ;
-  clear: right }
-
-div.sidebar p.rubric {
-  font-family: sans-serif ;
-  font-size: medium }
-
-div.system-messages {
-  margin: 5em }
-
-div.system-messages h1 {
-  color: red }
-
-div.system-message {
-  border: medium outset ;
-  padding: 1em }
-
-div.system-message p.system-message-title {
-  color: red ;
-  font-weight: bold }
-
-div.topic {
-  margin: 2em }
-
-h1.title {
-  text-align: center }
-
-h2.subtitle {
-  text-align: center }
-
-hr {
-  width: 75% }
-
-ol.simple, ul.simple {
-  margin-bottom: 1em }
-
-ol.arabic {
-  list-style: decimal }
-
-ol.loweralpha {
-  list-style: lower-alpha }
-
-ol.upperalpha {
-  list-style: upper-alpha }
-
-ol.lowerroman {
-  list-style: lower-roman }
-
-ol.upperroman {
-  list-style: upper-roman }
-
-p.attribution {
-  text-align: right ;
-  margin-left: 50% }
-
-p.caption {
-  font-style: italic }
-
-p.credits {
-  font-style: italic ;
-  font-size: smaller }
-
-p.label {
-  white-space: nowrap }
-
-p.rubric {
-  font-weight: bold ;
-  font-size: larger ;
-  color: maroon ;
-  text-align: center }
-
-p.sidebar-title {
-  font-family: sans-serif ;
-  font-weight: bold ;
-  font-size: larger }
-
-p.sidebar-subtitle {
-  font-family: sans-serif ;
-  font-weight: bold }
-
-p.topic-title {
-  font-weight: bold }
-
-pre.address {
-  margin-bottom: 0 ;
-  margin-top: 0 ;
-  font-family: serif ;
-  font-size: 100% }
-
-pre.line-block {
-  font-family: serif ;
-  font-size: 100% }
-
-pre.literal-block, pre.doctest-block {
-  margin-left: 2em ;
-  margin-right: 2em ;
-  background-color: #eeeeee }
-
-span.classifier {
-  font-family: sans-serif ;
-  font-style: oblique }
-
-span.classifier-delimiter {
-  font-family: sans-serif ;
-  font-weight: bold }
-
-span.interpreted {
-  font-family: sans-serif }
-
-span.option {
-  white-space: nowrap }
-
-span.option-argument {
-  font-style: italic }
-
-span.pre {
-  white-space: pre }
-
-span.problematic {
-  color: red }
-
-table {
-  margin-top: 0.5em ;
-  margin-bottom: 0.5em }
-
-table.citation {
-  border-left: solid thin gray ;
-  padding-left: 0.5ex }
-
-table.docinfo {
-  margin: 2em 4em }
-
-table.footnote {
-  border-left: solid thin black ;
-  padding-left: 0.5ex }
-
-td, th {
-  padding-left: 0.5em ;
-  padding-right: 0.5em ;
-  vertical-align: top }
-
-th.docinfo-name, th.field-name {
-  font-weight: bold ;
-  text-align: left ;
-  white-space: nowrap }
-
-h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
-  font-size: 100% }
-
-tt {
-  background-color: #eeeeee }
-
-ul.auto-toc {
-  list-style-type: none }
-
---></style>
+<link rel="stylesheet" href="default.css" type="text/css" />
 </head>
 <body>
 <h1 class="title">Running Boost Regression Tests</h1>
@@ -352,6 +114,43 @@ 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>
+<p>Even if you've already been using a custom driver script, and for some 
+reason you don't  want <tt class="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>
+<p>In fact, it's just a matter of modifying your script to perform two straightforward 
+operations:</p>
+<ol class="arabic">
+<li><p class="first"><em>Timestamp file creation</em> needs to be done before the CVS update/checkout.
+The file's location doesn't matter (nor does the content), as long as you know how 
+to access it later. Making your script to do something as simple as
+<tt class="literal"><span class="pre">echo</span> <span class="pre">&gt;timestamp</span></tt> would work just fine.</p>
+</li>
+<li><p class="first"><em>Collecting and uploading logs</em> can be done any time after <tt class="literal"><span class="pre">process_jam_log</span></tt>' s
+run, and is as simple as an invocation of the local copy of
+<tt class="literal"><span class="pre">boost/tools/regression/xsl_reports/runner/collect_and_upload_logs.py</span></tt>
+script that was just obtained from the CVS with the rest of the sources.
+You'd need to provide <tt class="literal"><span class="pre">collect_and_upload_logs.py</span></tt> with the following three
+arguments:</p>
+<pre class="literal-block">
+--locate-root   directory to to scan for &quot;test_log.xml&quot; files
+--runner        runner ID (e.g. &quot;Metacomm&quot;)
+--timestamp     path to a file which modification time will be used 
+                as a timestamp of the run (&quot;timestamp&quot; by default)
+</pre>
+<p>For example, assuming that the run's resulting  binaries are in 
+<tt class="literal"><span class="pre">/Volumes/stuff/users/alexy/boost_regressions/results</span></tt> directory,
+the  <tt class="literal"><span class="pre">collect_and_upload_logs.py</span></tt> invocation might look like this:</p>
+<pre class="literal-block">
+python boost/tools/regression/xsl_reports/runner/collect_and_upload_logs.py 
+   --locate-root=/Volumes/stuff/users/alexy/boost_regressions/results
+   --runner=agurtovoy
+   --timestamp=/Volumes/stuff/users/alexy/boost_regressions/timestamp
+</pre>
+</li>
+</ol>
+</div>
 </div>
 <div class="section" id="feedback">
 <h2><a name="feedback">Feedback</a></h2>
@@ -409,7 +208,7 @@ are running on a Windows platform. Contributions are welcome!</td></tr>
 <hr class="footer" />
 <div class="footer">
 <a class="reference" href="instructions.rst">View document source</a>.
-Generated on: 2004-07-26 12:31 UTC.
+Generated on: 2004-07-28 10:40 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>
 </body>

+ 40 - 0
tools/regression/xsl_reports/runner/instructions.rst

@@ -129,6 +129,46 @@ state by several hours, sometimes up to twelve. By contrast, the tarball the scr
 downloads by default is at most one hour behind.
 
 
+Integration with a custom driver script
+.......................................
+
+Even if you've already been using a custom driver script, and for some 
+reason you don't  want ``regression.py`` to take over of the entire test cycle, 
+getting your regression results into `Boost-wide reports`__ is still easy!
+
+In fact, it's just a matter of modifying your script to perform two straightforward 
+operations:
+
+1. *Timestamp file creation* needs to be done before the CVS update/checkout.
+   The file's location doesn't matter (nor does the content), as long as you know how 
+   to access it later. Making your script to do something as simple as
+   ``echo >timestamp`` would work just fine.
+
+2. *Collecting and uploading logs* can be done any time after ``process_jam_log``' s
+   run, and is as simple as an invocation of the local copy of
+   ``boost/tools/regression/xsl_reports/runner/collect_and_upload_logs.py``
+   script that was just obtained from the CVS with the rest of the sources.
+   You'd need to provide ``collect_and_upload_logs.py`` with the following three
+   arguments::
+
+        --locate-root   directory to to scan for "test_log.xml" files
+        --runner        runner ID (e.g. "Metacomm")
+        --timestamp     path to a file which modification time will be used 
+                        as a timestamp of the run ("timestamp" by default)
+
+   For example, assuming that the run's resulting  binaries are in 
+   ``/Volumes/stuff/users/alexy/boost_regressions/results`` directory,
+   the  ``collect_and_upload_logs.py`` invocation might look like this::
+
+       python boost/tools/regression/xsl_reports/runner/collect_and_upload_logs.py 
+          --locate-root=/Volumes/stuff/users/alexy/boost_regressions/results
+          --runner=agurtovoy
+          --timestamp=/Volumes/stuff/users/alexy/boost_regressions/timestamp
+
+
+__ http://www.boost.org/regression-logs/developer/
+
+
 Feedback
 --------
 

粤ICP备19079148号