[CMake] llvm_process_sources: Introduce a parameter, ADDITIONAL_HEADERS.

[oota-llvm.git] / docs / TestingGuide.rst

diff --git a/docs/TestingGuide.rst b/docs/TestingGuide.rst
index 3cfbb219e6509c8d488b789fd0f2cbddc5827a1f..eb61bdfc2c1184c79ecd854c03c8a4b25b6d40ca 100644 (file)
--- a/docs/TestingGuide.rst
+++ b/docs/TestingGuide.rst
@@ -21,9 +21,9 @@ tests.
 Requirements
 ============
 
-In order to use the LLVM testing infrastructure, you will need all of
-the software required to build LLVM, as well as
-`Python <http://python.org>`_ 2.4 or later.
+In order to use the LLVM testing infrastructure, you will need all of the
+software required to build LLVM, as well as `Python <http://python.org>`_ 2.5 or
+later.
 
 LLVM testing infrastructure organization
 ========================================
@@ -120,12 +120,14 @@ can run the LLVM and Clang tests simultaneously using:
 
     % make check-all
 
-To run the tests with Valgrind (Memcheck by default), just append
-``VG=1`` to the commands above, e.g.:
+To run the tests with Valgrind (Memcheck by default), use the ``LIT_ARGS`` make
+variable to pass the required options to lit. For example, you can use:
 
 .. code-block:: bash
 
-    % make check VG=1
+    % make check LIT_ARGS="-v --vg --vg-leak"
+
+to enable testing with valgrind and with leak checking enabled.
 
 To run individual tests or subsets of tests, you can use the ``llvm-lit``
 script which is built as part of LLVM. For example, to run the
@@ -402,20 +404,12 @@ To add more variables, look at ``test/lit.cfg``.
 Other Features
 --------------
 
-To make RUN line writing easier, there are several helper scripts and programs
-in the ``llvm/test/Scripts`` directory. This directory is in the PATH
-when running tests, so you can just call these scripts using their name.
-For example:
-
-``ignore``
-   This script runs its arguments and then always returns 0. This is useful
-   in cases where the test needs to cause a tool to generate an error (e.g.
-   to check the error output). However, any program in a pipeline that
-   returns a non-zero result will cause the test to fail.  This script
-   overcomes that issue and nicely documents that the test case is
-   purposefully ignoring the result code of the tool
+To make RUN line writing easier, there are several helper programs. These
+helpers are in the PATH when running tests, so you can just call them using
+their name. For example:
+
 ``not``
-   This script runs its arguments and then inverts the result code from it.
+   This program runs its arguments and then inverts the result code from it.
    Zero result codes become 1. Non-zero result codes become 0.
 
 Sometimes it is necessary to mark a test case as "expected fail" or