[llvm-commits] CVS: llvm/docs/TestingGuide.html

[Misha Brukman]

Changes in directory llvm/docs:

TestingGuide.html updated: 1.24 -> 1.25
---
Log message:

* Add directions to send output of nightly test script to llvm-testresults at cs
* Use the doc_code class to nightly test script example
* Enclose file names in <tt> tags
* Achieve compliance with HTML-4.01 Strict


---
Diffs of the changes:  (+24 -18)

 TestingGuide.html |   42 ++++++++++++++++++++++++------------------
 1 files changed, 24 insertions(+), 18 deletions(-)


Index: llvm/docs/TestingGuide.html
diff -u llvm/docs/TestingGuide.html:1.24 llvm/docs/TestingGuide.html:1.25
--- llvm/docs/TestingGuide.html:1.24	Wed Dec 22 00:45:24 2004
+++ llvm/docs/TestingGuide.html	Thu Mar 10 16:51:59 2005
@@ -116,7 +116,9 @@
 <pre>
 % gmake -C llvm/test TESTSUITE=Regression/Transforms
 </pre>
-<dd><b>Note: If you are running the tests with <tt>objdir != subdir</tt> you must have run the complete testsuite before you can specify a subdirectory.</b></dd>
+
+<p><b>Note: If you are running the tests with <tt>objdir != subdir</tt> you must
+have run the complete testsuite before you can specify a subdirectory.</b></p>
 
 <p>To run the comprehensive test suite (tests that compile and execute whole 
 programs), run the <tt>llvm-test</tt> tests:</p>
@@ -284,7 +286,8 @@
 <p>There are a couple patterns within a <tt>RUN</tt> line that the
 llvm-runtest procedure looks for and replaces with the appropriate
 syntax:</p>
-<ul>
+
+<dl style="margin-left: 25px">
 <dt>%p</dt> 
 <dd>The path to the source directory. This is for locating
 any supporting files that are not generated by the test, but used by
@@ -304,7 +307,7 @@
 
 <dt>%llvmgcc</dt> <dd>Full path to the llvm-gcc executable.</dd>
 <dt>%llvmgxx</dt> <dd>Full path to the llvm-g++ executable.</dd>
-</ul>
+</dl>
 
 <p>There are also several scripts in the llvm/test/Scripts directory
 that you might find useful when writing <tt>RUN</tt> lines.</p>
@@ -467,18 +470,21 @@
 and then delete the checked out tree.  This tester is designed to ensure that 
 programs don't break as well as keep track of LLVM's progress over time.</p>
 
-<p>
-If you'd like to set up an instance of the nightly tester to run on your 
-machine, take a look at the comments at the top of the utils/NightlyTester.pl
-file.  We usually run it from a crontab entry that looks ilke this:
-</p>
+<p>If you'd like to set up an instance of the nightly tester to run on your
+machine, take a look at the comments at the top of the
+<tt>utils/NightlyTester.pl</tt> file.  We usually run it from a crontab entry
+that looks ilke this:</p>
 
+<div class="doc_code">
 <pre>
-5 3 * * *  $HOME/llvm/utils/NightlyTest.pl -parallel -enable-linscan ...CVSREPOSTORY... $HOME/buildtest-X86 $HOME/cvs/testresults-X86
+5 3 * * *  $HOME/llvm/utils/NightlyTest.pl -parallel $CVSROOT $HOME/buildtest-X86 $HOME/cvs/testresults-X86
 </pre>
+</div>
 
 <p>Or, you can create a shell script to encapsulate the running of the script.
-The optimized x86 Linux nightly test is run from just such a script:
+The optimized x86 Linux nightly test is run from just such a script:</p>
+
+<div class="doc_code">
 <pre>
 #!/bin/bash
 BASE=/proj/work/llvm/nightlytest
@@ -490,15 +496,15 @@
 export LD_LIBRARY_PATH=/proj/install/lib
 cd $BASE
 cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
-nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals
+nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals 2>&1 > output.log
+mail -s 'X86 nightly tester results' <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-testresults">llvm-testresults at cs.uiuc.edu</a> < output.log
 </pre>
+</div>
+
+<p>Take a look at the <tt>NightlyTest.pl</tt> file to see what all of the flags
+and strings do.  If you start running the nightly tests, please let us know and
+we'll link your page to the global tester page.  Thanks!</p>
 
-<p>
-Take a look at the NightlyTest.pl file to see what all of the flags and 
-strings do.  If you start running the nightly tests, please let us know and 
-we'll link your page to the global tester page.  Thanks!
-</p>
-      
 </div>
 
 <!-- *********************************************************************** -->
@@ -512,7 +518,7 @@
 
   John T. Criswell<br>
   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br/>
-  Last modified: $Date: 2004/12/22 06:45:24 $
+  Last modified: $Date: 2005/03/10 22:51:59 $
 </address>
 </body>
 </html>