From 0f7d9dc391f6ea9b726417367595ccfa45c7ed9f Mon Sep 17 00:00:00 2001 From: Andrew Trick Date: Thu, 23 Sep 2010 20:26:44 +0000 Subject: [PATCH] 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. llvm-svn: 114691 --- docs/GettingStarted.html | 32 +++++++++++++++++--------------- docs/TestingGuide.html | 18 +++++++++--------- 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index b75b1c654a6..94d85cbca29 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -44,7 +44,7 @@
  • llvm/projects
  • llvm/runtime
  • llvm/test
    • -
  • llvm-test
    • +
  • test-suite
  • llvm/tools
  • llvm/utils
  • llvm/win32
    • @@ -80,11 +80,12 @@

    Welcome to LLVM! In order to get started, you first need to know some basic information.

    -

    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.

    +

    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.

    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 @@ compiled into LLVM bitcode, a program can be manipulated with the LLVM tools from the LLVM suite.

    -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.

    @@ -142,6 +143,7 @@ and performance.
  • cd where-you-want-llvm-to-live
  • cd llvm/projects
  • gunzip --stdout llvm-test-version.tar.gz | tar -xvf - +
  • mv llvm-test-version test-suite
    • @@ -162,7 +164,7 @@ and performance.

    Optionally, specify for directory 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.

    + want to run test-suite or do some special kinds of LLVM builds.

  • --enable-spec2000=directory

    Enable the SPEC2000 benchmarks for testing. The SPEC2000 benchmarks should be available in @@ -684,7 +686,7 @@ compressed with the gzip program.

    Source release for the LLVM libraries and tools.
    llvm-test-x.y.tar.gz
    -
    Source release for the LLVM test suite.
    +
    Source release for the LLVM test-suite.
    llvm-gcc-4.2-x.y.source.tar.gz
    Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root @@ -751,7 +753,7 @@ you get it from the Subversion repository:

     % 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
    @@ -774,7 +776,7 @@ instructions to successfully get and build the LLVM GCC front-end.

    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 build llvm-gcc yourself after building the main LLVM repository.

    @@ -795,9 +797,9 @@ to your PATH environment variable. For example, if you uncompressed th

    If you now want to build LLVM from source, when you configure LLVM, it will automatically detect llvm-gcc's presence (if it is in your path) enabling its -use in llvm-test. Note that you can always build or install llvm-gcc at any +use in test-suite. Note that you can always build or install llvm-gcc 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.

    As a convenience for Windows users, the front end binaries for MinGW/x86 include @@ -1348,7 +1350,7 @@ end to compile.

    -
    test-suite
    +
    test-suite

    This is not a directory in the normal llvm module; it is a separate Subversion @@ -1408,7 +1410,7 @@ information is in the Command Guide.

    llvm-ld
    llvm-ld is a general purpose and extensible linker for LLVM. - This is the linker invoked by llvmc. It performsn standard link time + This is the linker invoked by llvmc. 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.
    diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index e4db61656bb..921069d133e 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -40,7 +40,7 @@
  • Configuring External Tests
  • Running different tests
  • Generating test output
    • -
  • Writing custom tests for llvm-test
    • +
  • Writing custom tests for test-suite
    • @@ -870,34 +870,34 @@ want tested and run gmake there. Alternatively, you can run a different test using the TEST variable to change what tests or run on the selected programs (see below for more info).

    -

    In addition for testing correctness, the llvm-test directory also +

    In addition for testing correctness, the test-suite 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.

    -

    llvm-test tests are divided into three types of tests: MultiSource, +

    test-suite tests are divided into three types of tests: MultiSource, SingleSource, and External.

    @@ -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.

    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 "test-suite/TEST.XXX.Makefile" fragment (where XXX is the name of your -test) and an "llvm-test/TEST.XXX.report" file that indicates how to +test) and a "test-suite/TEST.XXX.report" 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.