Files
CMake/Tests
Kyle Edwards 81c88bb261 Merge topic 'cmake-presets-doc-move' into release-3.19
4a123fc28c Help: Clarify purpose of warnings and errors
6c74bcfc20 Help: Make architecture and toolset descriptions generic
45766789a0 Help: Add inheritance to CMakePresets.json example
88c9d6f6eb Help: Add documentation for debug field
efab856008 Help: Show environment field
2208db114c Help: Show multiple ways of doing cacheVariables
d30f85193f Help: Move vendor field into example
b9c8c57860 Help: s/unusedVars/unusedCli/
...

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !5373
2020-10-20 11:59:54 -04:00
..
2020-09-24 15:19:54 -04:00

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.