[llvm-commits] [llvm] r114691 - in /llvm/trunk/docs: GettingStarted.html TestingGuide.html
Andrew Trick
atrick at apple.com
Thu Sep 23 13:26:45 PDT 2010
Author: atrick
Date: Thu Sep 23 15:26:44 2010
New Revision: 114691
URL: http://llvm.org/viewvc/llvm-project?rev=114691&view=rev
Log:
Fix Getting Started docs.
configure expects LLVM Test Suite to be in projects/test-suite.
Made the "getting started" and "testing infrastructure" docs internally consistent.
Avoid confusion between llvm-test and llvm/test.
Modified:
llvm/trunk/docs/GettingStarted.html
llvm/trunk/docs/TestingGuide.html
Modified: llvm/trunk/docs/GettingStarted.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GettingStarted.html?rev=114691&r1=114690&r2=114691&view=diff
==============================================================================
--- llvm/trunk/docs/GettingStarted.html (original)
+++ llvm/trunk/docs/GettingStarted.html Thu Sep 23 15:26:44 2010
@@ -44,7 +44,7 @@
<li><a href="#projects"><tt>llvm/projects</tt></a></li>
<li><a href="#runtime"><tt>llvm/runtime</tt></a></li>
<li><a href="#test"><tt>llvm/test</tt></a></li>
- <li><a href="#llvmtest"><tt>llvm-test</tt></a></li>
+ <li><a href="#test-suite"><tt>test-suite</tt></a></li>
<li><a href="#tools"><tt>llvm/tools</tt></a></li>
<li><a href="#utils"><tt>llvm/utils</tt></a></li>
<li><a href="#win32"><tt>llvm/win32</tt></a></li>
@@ -80,11 +80,12 @@
<p>Welcome to LLVM! In order to get started, you first need to know some
basic information.</p>
-<p>First, LLVM comes in two pieces. The first piece is the LLVM suite. This
-contains all of the tools, libraries, and header files needed to use the low
-level virtual machine. It contains an assembler, disassembler, bitcode
-analyzer and bitcode optimizer. It also contains a test suite that can be
-used to test the LLVM tools and the GCC front end.</p>
+<p>First, LLVM comes in three pieces. The first piece is the LLVM
+suite. This contains all of the tools, libraries, and header files
+needed to use the low level virtual machine. It contains an
+assembler, disassembler, bitcode analyzer and bitcode optimizer. It
+also contains basic regression tests that can be used to test the LLVM
+tools and the GCC front end.</p>
<p>The second piece is the GCC front end. This component provides a version of
GCC that compiles C and C++ code into LLVM bitcode. Currently, the GCC front
@@ -93,7 +94,7 @@
from the LLVM suite.</p>
<p>
-There is a third, optional piece called llvm-test. It is a suite of programs
+There is a third, optional piece called Test Suite. It is a suite of programs
with a testing harness that can be used to further test LLVM's functionality
and performance.
</p>
@@ -142,6 +143,7 @@
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
<li><tt>cd llvm/projects</tt>
<li><tt>gunzip --stdout llvm-test-<i>version</i>.tar.gz | tar -xvf -</tt>
+ <li><tt>mv llvm-test-<i>version</i> test-suite</tt>
</ol></li>
</ul></li>
@@ -162,7 +164,7 @@
<p>Optionally, specify for <i>directory</i> the full pathname of the
C/C++ front end installation to use with this LLVM configuration. If
not specified, the PATH will be searched. This is only needed if you
- want to run the testsuite or do some special kinds of LLVM builds.</p></li>
+ want to run test-suite or do some special kinds of LLVM builds.</p></li>
<li><tt>--enable-spec2000=<i>directory</i></tt>
<p>Enable the SPEC2000 benchmarks for testing. The SPEC2000
benchmarks should be available in
@@ -684,7 +686,7 @@
<dd>Source release for the LLVM libraries and tools.<br></dd>
<dt><tt>llvm-test-x.y.tar.gz</tt></dt>
- <dd>Source release for the LLVM test suite.</dd>
+ <dd>Source release for the LLVM test-suite.</dd>
<dt><tt>llvm-gcc-4.2-x.y.source.tar.gz</tt></dt>
<dd>Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root
@@ -751,7 +753,7 @@
<div class="doc_code">
<pre>
% cd llvm/projects
-% svn co http://llvm.org/svn/llvm-project/test-suite/trunk llvm-test
+% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
</pre>
</div>
@@ -774,7 +776,7 @@
<p>Before configuring and compiling the LLVM suite (or if you want to use just the LLVM
GCC front end) you can optionally extract the front end from the binary distribution.
-It is used for running the llvm-test testsuite and for compiling C/C++ programs. Note that
+It is used for running the LLVM test-suite and for compiling C/C++ programs. Note that
you can optionally <a href="GCCFEBuildInstrs.html">build llvm-gcc yourself</a> after building the
main LLVM repository.</p>
@@ -795,9 +797,9 @@
<p>If you now want to build LLVM from source, when you configure LLVM, it will
automatically detect <tt>llvm-gcc</tt>'s presence (if it is in your path) enabling its
-use in llvm-test. Note that you can always build or install <tt>llvm-gcc</tt> at any
+use in test-suite. Note that you can always build or install <tt>llvm-gcc</tt> at any
point after building the main LLVM repository: just reconfigure llvm and
-llvm-test will pick it up.
+test-suite will pick it up.
</p>
<p>As a convenience for Windows users, the front end binaries for MinGW/x86 include
@@ -1348,7 +1350,7 @@
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="llvmtest"><tt>test-suite</tt></a></div>
+<div class="doc_subsection"><a name="test-suite"><tt>test-suite</tt></a></div>
<div class="doc_text">
<p>This is not a directory in the normal llvm module; it is a separate
Subversion
@@ -1408,7 +1410,7 @@
<dt><tt><b>llvm-ld</b></tt></dt>
<dd><tt>llvm-ld</tt> is a general purpose and extensible linker for LLVM.
- This is the linker invoked by <tt>llvmc</tt>. It performsn standard link time
+ This is the linker invoked by <tt>llvmc</tt>. It performs standard link time
optimizations and allows optimization modules to be loaded and run so that
language specific optimizations can be applied at link time.</dd>
Modified: llvm/trunk/docs/TestingGuide.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/TestingGuide.html?rev=114691&r1=114690&r2=114691&view=diff
==============================================================================
--- llvm/trunk/docs/TestingGuide.html (original)
+++ llvm/trunk/docs/TestingGuide.html Thu Sep 23 15:26:44 2010
@@ -40,7 +40,7 @@
<li><a href="#testsuiteexternal">Configuring External Tests</a></li>
<li><a href="#testsuitetests">Running different tests</a></li>
<li><a href="#testsuiteoutput">Generating test output</a></li>
- <li><a href="#testsuitecustom">Writing custom tests for llvm-test</a></li>
+ <li><a href="#testsuitecustom">Writing custom tests for test-suite</a></li>
</ul>
</li>
</ol>
@@ -870,34 +870,34 @@
test using the <tt>TEST</tt> variable to change what tests or run on the
selected programs (see below for more info).</p>
-<p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
+<p>In addition for testing correctness, the <tt>test-suite</tt> directory also
performs timing tests of various LLVM optimizations. It also records
compilation times for the compilers and the JIT. This information can be
used to compare the effectiveness of LLVM's optimizations and code
generation.</p>
-<p><tt>llvm-test</tt> tests are divided into three types of tests: MultiSource,
+<p><tt>test-suite</tt> tests are divided into three types of tests: MultiSource,
SingleSource, and External.</p>
<ul>
-<li><tt>llvm-test/SingleSource</tt>
+<li><tt>test-suite/SingleSource</tt>
<p>The SingleSource directory contains test programs that are only a single
source file in size. These are usually small benchmark programs or small
programs that calculate a particular value. Several such programs are grouped
together in each directory.</p></li>
-<li><tt>llvm-test/MultiSource</tt>
+<li><tt>test-suite/MultiSource</tt>
<p>The MultiSource directory contains subdirectories which contain entire
programs with multiple source files. Large benchmarks and whole applications
go here.</p></li>
-<li><tt>llvm-test/External</tt>
+<li><tt>test-suite/External</tt>
<p>The External directory contains Makefiles for building code that is external
to (i.e., not distributed with) LLVM. The most prominent members of this
directory are the SPEC 95 and SPEC 2000 benchmark suites. The <tt>External</tt>
directory does not contain these actual tests, but only the Makefiles that know
how to properly compile these programs from somewhere else. The presence and
-location of these external programs is configured by the llvm-test
+location of these external programs is configured by the test-suite
<tt>configure</tt> script.</p></li>
</ul>
@@ -1084,9 +1084,9 @@
will tally counts of things you care about.</p>
<p>Following this, you can set up a test and a report that collects these and
-formats them for easy viewing. This consists of two files, an
+formats them for easy viewing. This consists of two files, a
"<tt>test-suite/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
-test) and an "<tt>llvm-test/TEST.XXX.report</tt>" file that indicates how to
+test) and a "<tt>test-suite/TEST.XXX.report</tt>" file that indicates how to
format the output into a table. There are many example reports of various
levels of sophistication included with the test suite, and the framework is very
general.</p>
More information about the llvm-commits
mailing list