summaryrefslogtreecommitdiffstats
path: root/lldb/docs/resources
diff options
context:
space:
mode:
authorJonas Devlieghere <jonas@devlieghere.com>2019-05-08 01:38:12 +0000
committerJonas Devlieghere <jonas@devlieghere.com>2019-05-08 01:38:12 +0000
commitda9a274a604d001b9c4adf03eb8abbb09bc26686 (patch)
tree8badff41afe6ede2d4871a74e00dfcbac6e8c426 /lldb/docs/resources
parent255b85f03c5db51478ea80146af5906adfb7c02a (diff)
downloadbcm5719-llvm-da9a274a604d001b9c4adf03eb8abbb09bc26686.tar.gz
bcm5719-llvm-da9a274a604d001b9c4adf03eb8abbb09bc26686.zip
[Docs] Re-order homepage: Download -> Build -> Test
I also reformatted some paragraphs to 80 cols. llvm-svn: 360218
Diffstat (limited to 'lldb/docs/resources')
-rw-r--r--lldb/docs/resources/test.rst29
1 files changed, 16 insertions, 13 deletions
diff --git a/lldb/docs/resources/test.rst b/lldb/docs/resources/test.rst
index 67cebd71759..91cc4a26dbb 100644
--- a/lldb/docs/resources/test.rst
+++ b/lldb/docs/resources/test.rst
@@ -1,5 +1,5 @@
-Testing LLDB
-============
+Testing
+=======
The LLDB test suite consists of Python scripts located under the test
directory. Each script contains a number of test cases and is usually
@@ -20,10 +20,10 @@ against a debug version of LLDB.
The easiest way to run the LLDB test suite is to use the ``check-lldb`` build
target. By default, the ``check-lldb`` target builds the test programs with the
same compiler that was used to build LLDB. To build the tests with a different
-compiler, you can set the ``LLDB_TEST_C_COMPILER`` or the ``LLDB_TEST_CXX_COMPILER``
-CMake variables. These variables are ignored unless the respective
-``LLDB_TEST_USE_CUSTOM_C_COMPILER`` and ``LLDB_TEST_USE_CUSTOM_CXX_COMPILER`` are set
-to ``ON``.
+compiler, you can set the ``LLDB_TEST_C_COMPILER`` or the
+``LLDB_TEST_CXX_COMPILER`` CMake variables. These variables are ignored unless
+the respective ``LLDB_TEST_USE_CUSTOM_C_COMPILER`` and
+``LLDB_TEST_USE_CUSTOM_CXX_COMPILER`` are set to ``ON``.
It is possible to customize the architecture of the test binaries and compiler
used by appending ``-A`` and ``-C`` options respectively to the CMake variable
@@ -44,14 +44,17 @@ environment. This is due to lack of the ``$ORIGIN`` linker feature.
Running a Specific Test or Set of Tests
---------------------------------------
-In addition to running all the LLDB test suites with the "check-lldb" CMake target above, it is possible to run individual LLDB tests. For example, to run the test cases defined in TestInferiorCrashing.py, run:
+In addition to running all the LLDB test suites with the "check-lldb" CMake
+target above, it is possible to run individual LLDB tests. For example, to run
+the test cases defined in TestInferiorCrashing.py, run:
::
> cd $lldb/test
> python dotest.py --executable <path-to-lldb> -p TestInferiorCrashing.py ../packages/Python/lldbsuite/test
-If the test is not specified by name (e.g. if you leave the -p argument off), LLDB will run all tests in that directory:
+If the test is not specified by name (e.g. if you leave the -p argument off),
+LLDB will run all tests in that directory:
::
@@ -63,11 +66,11 @@ Many more options that are available. To see a list of all of them, run:
> python dotest.py -h
-The ``dotest.py`` script runs tests in parallel by default. To disable the parallel
-test running feature, use the ``--no-multiprocess`` flag. The number of concurrent
-tests is controlled by the ``LLDB_TEST_THREADS`` environment variable or the
-``--threads command`` line parameter. The default value is the number of CPU cores
-on your system.
+The ``dotest.py`` script runs tests in parallel by default. To disable the
+parallel test running feature, use the ``--no-multiprocess`` flag. The number
+of concurrent tests is controlled by the ``LLDB_TEST_THREADS`` environment
+variable or the ``--threads command`` line parameter. The default value is the
+number of CPU cores on your system.
The parallel test running feature will handle an additional ``--test-subdir
SUBDIR`` arg. When specified, ``SUBDIR`` is relative to the root test directory
OpenPOWER on IntegriCloud