Browse Source

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.
scivision 2 years ago
parent
commit
6f354a6d57
1 changed files with 3 additions and 2 deletions
  1. 3 2
      Help/manual/ctest.1.rst

+ 3 - 2
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>