summaryrefslogtreecommitdiffstats
path: root/Tests/README.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-06-14 19:04:19 (GMT)
committerBrad King <brad.king@kitware.com>2017-06-14 19:04:19 (GMT)
commit1c5471527e08b3a1c883889024773678741b77d0 (patch)
treeec2f44ddcf487d9d6e66e64d9d8f0aad5fdd041f /Tests/README.rst
parent4e3483c0074e07efaffd5269a4b5fb1a38a2bc50 (diff)
downloadCMake-1c5471527e08b3a1c883889024773678741b77d0.zip
CMake-1c5471527e08b3a1c883889024773678741b77d0.tar.gz
CMake-1c5471527e08b3a1c883889024773678741b77d0.tar.bz2
Tests: Document test directory layout in a README.rst
Cross-reference the CMake Source Code Guide document. Also drop the outdated `Tests/README` file.
Diffstat (limited to 'Tests/README.rst')
-rw-r--r--Tests/README.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/Tests/README.rst b/Tests/README.rst
new file mode 100644
index 0000000..3e98938
--- /dev/null
+++ b/Tests/README.rst
@@ -0,0 +1,31 @@
+CMake Tests Directory
+*********************
+
+This directory contains the CMake test suite.
+See also the `CMake Source Code Guide`_.
+
+.. _`CMake Source Code Guide`: ../Help/dev/source.rst
+
+Many tests exist as immediate subdirectories, but some tests
+are organized as follows.
+
+* ``CMakeLib/``:
+ Source code, used for tests, that links to the ``CMakeLib`` library
+ defined over in ``Source/``.
+
+* ``CMakeOnly/``:
+ Deprecated. Tests that run CMake to generate a project but not build it.
+ Superseded by ``Tests/RunCMake/``.
+
+* ``Find*/``:
+ Tests for specific find modules that can only be run on machines with
+ the corresponding packages installed. They are enabled in
+ ``CMakeLists.txt`` by undocumented options used on CI builds.
+
+* ``Module/``:
+ Tests for specific CMake modules.
+
+* ``RunCMake/``:
+ Tests that run CMake and/or other tools while precisely checking
+ their return code and stdout/stderr content. Useful for testing
+ error cases and diagnostic output.