summaryrefslogtreecommitdiff
path: root/Help/manual
diff options
context:
space:
mode:
authorscivision <scivision@users.noreply.github.com>2023-02-17 10:10:05 -0500
committerscivision <scivision@users.noreply.github.com>2023-02-18 20:22:23 -0500
commit6f354a6d573104260b3bc801f7e9a527404280cb (patch)
treee5e080ffaac2a6d6e3e02766cac87270360d9c66 /Help/manual
parentf0e60ea867f8ac96fd855754b9f71329d36f7e52 (diff)
downloadcmake-6f354a6d573104260b3bc801f7e9a527404280cb.tar.gz
Help: ctest(1): emphasize the --test-dir option
it seems few people know of this option and needlessly add extra shell commands to change directory.
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/ctest.1.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst
index 5e82faae0d..994ae47b77 100644
--- a/Help/manual/ctest.1.rst
+++ b/Help/manual/ctest.1.rst
@@ -11,7 +11,7 @@ Synopsis
.. parsed-literal::
`Run Tests`_
- ctest [<options>]
+ ctest [<options>] [--test-dir <path-to-build>]
`Build and Test Mode`_
ctest --build-and-test <path-to-source> <path-to-build>
@@ -354,7 +354,8 @@ Run Tests
.. option:: --test-dir <dir>
- Specify the directory in which to look for tests.
+ Specify the directory in which to look for tests, typically a CMake project
+ build directory. If not specified, the current directory is used.
.. option:: --test-output-size-passed <size>