diff docs/TestingGuide.rst @ 120:1172e4bd9c6f

update 4.0.0
author mir3636
date Fri, 25 Nov 2016 19:14:25 +0900
parents 7d135dc70f03
children 803732b1fca8
line wrap: on
line diff
--- a/docs/TestingGuide.rst	Tue Jan 26 22:56:36 2016 +0900
+++ b/docs/TestingGuide.rst	Fri Nov 25 19:14:25 2016 +0900
@@ -25,6 +25,10 @@
 software required to build LLVM, as well as `Python <http://python.org>`_ 2.7 or
 later.
 
+If you intend to run the :ref:`test-suite <test-suite-overview>`, you will also
+need a development version of zlib (zlib1g-dev is known to work on several Linux
+distributions).
+
 LLVM testing infrastructure organization
 ========================================
 
@@ -99,19 +103,11 @@
 Regression tests
 ----------------
 
-To run all of the LLVM regression tests, use the master Makefile in the
-``llvm/test`` directory. LLVM Makefiles require GNU Make (read the :doc:`LLVM
-Makefile Guide <MakefileGuide>` for more details):
+To run all of the LLVM regression tests use the check-llvm target:
 
 .. code-block:: bash
 
-    % make -C llvm/test
-
-or:
-
-.. code-block:: bash
-
-    % make check
+    % make check-llvm
 
 If you have `Clang <http://clang.llvm.org/>`_ checked out and built, you
 can run the LLVM and Clang tests simultaneously using:
@@ -391,6 +387,23 @@
 triple, test with the specific FileCheck and put it into the specific
 directory that will filter out all other architectures.
 
+REQUIRES and REQUIRES-ANY directive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Some tests can be enabled only in specific situation - like having
+debug build. Use ``REQUIRES`` directive to specify those requirements.
+
+.. code-block:: llvm
+
+    ; This test will be only enabled in the build with asserts
+    ; REQUIRES: asserts
+
+You can separate requirements by a comma.
+``REQUIRES`` means all listed requirements must be satisfied.
+``REQUIRES-ANY`` means at least one must be satisfied.
+
+List of features that can be used in ``REQUIRES`` and ``REQUIRES-ANY`` can be
+found in lit.cfg files.
 
 Substitutions
 -------------
@@ -543,6 +556,8 @@
 (b) it speeds things up for really big test cases by avoiding
     interpretation of the remainder of the file.
 
+.. _test-suite-overview:
+
 ``test-suite`` Overview
 =======================