summaryrefslogtreecommitdiffstats
path: root/Tests/RunCMake/README.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-05-23 18:27:01 (GMT)
committerBrad King <brad.king@kitware.com>2024-05-23 18:36:49 (GMT)
commitaff4dc47c4dc80595e4d8b75215a193bbcc41543 (patch)
tree9760b6dd314bc0ae3ac8a1f01c7e05ebf9211017 /Tests/RunCMake/README.rst
parent1f8bcd0a7cbb5ebb1e9e29aa63f1768b2a7eaa61 (diff)
downloadCMake-aff4dc47c4dc80595e4d8b75215a193bbcc41543.zip
CMake-aff4dc47c4dc80595e4d8b75215a193bbcc41543.tar.gz
CMake-aff4dc47c4dc80595e4d8b75215a193bbcc41543.tar.bz2
Tests/RunCMake: Cross-reference README from main Tests/README
Diffstat (limited to 'Tests/RunCMake/README.rst')
-rw-r--r--Tests/RunCMake/README.rst16
1 files changed, 14 insertions, 2 deletions
diff --git a/Tests/RunCMake/README.rst b/Tests/RunCMake/README.rst
index 8850d7a..9ff7ed2 100644
--- a/Tests/RunCMake/README.rst
+++ b/Tests/RunCMake/README.rst
@@ -1,5 +1,17 @@
-This directory contains tests that run CMake to configure a project
-but do not actually build anything. To add a test:
+CMake Tests/RunCMake Directory
+******************************
+
+This directory contains tests that run CMake and/or other tools while
+precisely checking their return code and stdout/stderr content.
+The RunCMake infrastructure is useful for testing error cases and
+diagnostic output.
+
+See also `../README.rst`_ and the `CMake Source Code Guide`_.
+
+.. _`../README.rst`: ../README.rst
+.. _`CMake Source Code Guide`: ../../Help/dev/source.rst
+
+To add a test:
1. Add a subdirectory named for the test, say ``<Test>/``.