Tests/RunCMake: Cross-reference README from main Tests/README

This commit is contained in:
Brad King
2024-05-23 14:27:01 -04:00
parent 1f8bcd0a7c
commit aff4dc47c4
2 changed files with 18 additions and 2 deletions

View File

@@ -29,3 +29,7 @@ are organized as follows.
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.
See `RunCMake/README.rst`_.
.. _`RunCMake/README.rst`: RunCMake/README.rst

View File

@@ -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>/``.