summaryrefslogtreecommitdiffstats
path: root/Help/command/add_test.rst
diff options
context:
space:
mode:
authorJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2018-10-25 11:34:27 (GMT)
committerJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2018-10-25 11:47:31 (GMT)
commitadbaadf0eef855aeb043babceae67e324b69fef0 (patch)
treecafc762ddcd625ba840242484da0d3ffe3a226f2 /Help/command/add_test.rst
parent2459b5e8324ced6435a12fedf98067a0d9fac5f1 (diff)
downloadCMake-adbaadf0eef855aeb043babceae67e324b69fef0.zip
CMake-adbaadf0eef855aeb043babceae67e324b69fef0.tar.gz
CMake-adbaadf0eef855aeb043babceae67e324b69fef0.tar.bz2
Help: Apply syntax highlighting to project commands
* Replace most "::" by ".. code-block:: cmake" * Header sentence in imperative voice, detailed command description in present tense.
Diffstat (limited to 'Help/command/add_test.rst')
-rw-r--r--Help/command/add_test.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst
index d8a96e9..a8c257d 100644
--- a/Help/command/add_test.rst
+++ b/Help/command/add_test.rst
@@ -3,13 +3,13 @@ add_test
Add a test to the project to be run by :manual:`ctest(1)`.
-::
+.. code-block:: cmake
add_test(NAME <name> COMMAND <command> [<arg>...]
[CONFIGURATIONS <config>...]
[WORKING_DIRECTORY <dir>])
-Add a test called ``<name>``. The test name may not contain spaces,
+Adds a test called ``<name>``. The test name may not contain spaces,
quotes, or other characters special in CMake syntax. The options are:
``COMMAND``
@@ -39,7 +39,9 @@ The ``COMMAND`` and ``WORKING_DIRECTORY`` options may use "generator
expressions" with the syntax ``$<...>``. See the
:manual:`cmake-generator-expressions(7)` manual for available expressions.
-Example usage::
+Example usage:
+
+.. code-block:: cmake
add_test(NAME mytest
COMMAND testDriver --config $<CONFIGURATION>
@@ -57,7 +59,7 @@ file produced by target ``myexe``.
---------------------------------------------------------------------
-::
+.. code-block:: cmake
add_test(<name> <command> [<arg>...])