diff options
author | Andrew Trick <atrick@apple.com> | 2010-09-23 20:26:44 +0000 |
---|---|---|
committer | Andrew Trick <atrick@apple.com> | 2010-09-23 20:26:44 +0000 |
commit | bcf0116751a409ba6640d5a248f706c5ca65835a (patch) | |
tree | 7061d9182dfa8d69f53b2a61ef99baa5856a559d /docs/TestingGuide.html | |
parent | e15eb4e14cd543b925a837026cbdde9f94393e1c (diff) |
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.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@114691 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/TestingGuide.html')
-rw-r--r-- | docs/TestingGuide.html | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index e4db61656b..921069d133 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -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 @@ want tested and run <tt>gmake</tt> there. Alternatively, you can run a different 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 @@ many times it triggers. First thing you should do is add an LLVM 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> |