From: John Mosby Date: Mon, 30 Mar 2009 04:37:51 +0000 (+0000) Subject: Clarify section on setting up and running test-suite X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=24446d671a91a698c82d18e575b4f79498ed35ce;p=oota-llvm.git Clarify section on setting up and running test-suite git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@68023 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index 6e48d366f4c..cf40733eba9 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -695,12 +695,14 @@ will help you separate benign warnings from actual test failures.

First, all tests are executed within the LLVM object directory tree. They are not executed inside of the LLVM source tree. This is because the -test suite creates temporary files during execution.

+test suite creates temporary files during execution. This means you must create +a build tree separate from the LLVM source tree in which to run the test suite.

To run the test suite, you need to use the following steps:

    -
  1. cd into the llvm/projects directory
    2. +
  2. cd into the llvm/projects directory in your source tree. +

  3. Check out the test-suite module with:

    @@ -709,24 +711,35 @@ test suite creates temporary files during execution.

    % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite - -

    This will get the test suite into llvm/projects/llvm-test

    - -

  4. Configure the test suite using llvm configure. This will automatically - configure test-suite. You must do it from the top level otherwise llvm-gcc - will not be set which is required to run llvm-test:

    +

    This will get the test suite into llvm/projects/test-suite. +
    [The Makefiles expect the test suite directory to be named either + test-suite or llvm-test. To be safe, use + test-suite as in the above svn command line.]

    +
    5. +

  5. Configure llvm from the top level of each build tree (LLVM object directory tree) + in which you want to run the test suite, just like what you do before building LLVM.

    +

    When running configure, you must either: (1) have llvm-gcc + in your path, or (2) specify the directory where llvm-gcc is + installed using --with-llvmgccdir=$LLVM_GCC_DIR.

    +

    This step tells the configure machinery that the test suite + is now available so it can be configured for your build tree:

    -% cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure --with-llvmgccdir=$LLVM_GCC_DIR
+% cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure [--with-llvmgccdir=$LLVM_GCC_DIR]
    -

    Note that that $LLVM_GCC_DIR is the directory where you - installed llvm-gcc, not its src or obj directory.

    +

    [Remember that $LLVM_GCC_DIR is the directory where you + installed llvm-gcc, not its src or obj directory.]

    6. -

  6. Change back to the llvm/projects/test-suite directory you created before - and run gmake (or just "make" on systems where GNU make is - the default, such as linux.

    7. +

  7. You can now run the test suite from your build tree as follows:

    +
    +
    +% cd $LLVM_OBJ_ROOT/projects/test-suite
+% make
+
    +
    +

Note that the second and third steps only need to be done once. After you have the suite checked out and configured, you don't need to do it again (unless