diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-03-13 12:11:17 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-03-13 20:27:54 (GMT) |
| commit | 8b43adc45c2cf7a25b739589dec2010029f91a83 (patch) | |
| tree | 93fc3ea9c0e064627d143f9d94847b276c0bda3c /Help/manual | |
| parent | b2584ce069eae0d4b5a1cccf19295e5fde4c1082 (diff) | |
| download | CMake-8b43adc45c2cf7a25b739589dec2010029f91a83.zip CMake-8b43adc45c2cf7a25b739589dec2010029f91a83.tar.gz CMake-8b43adc45c2cf7a25b739589dec2010029f91a83.tar.bz2 | |
Help: Clarify ctest build-and-test mode options
Fixes: #17807
Diffstat (limited to 'Help/manual')
| -rw-r--r-- | Help/manual/ctest.1.rst | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index a04c403..75af22e 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -368,15 +368,17 @@ for "SubprojectB"). Build and Test Mode =================== -CTest provides a command-line signature to to configure (i.e. run cmake on), -build, and or execute a test:: +CTest provides a command-line signature to configure (i.e. run cmake on), +build, and/or execute a test:: ctest --build-and-test <path-to-source> <path-to-build> - --build-generator <generator> [<options>...] [-- <build-options>...] - [--test-command <test>] + --build-generator <generator> + [<options>...] + [--build-options <opts>...] + [--test-command <command> [<args>...]] The configure and test steps are optional. The arguments to this command line -are the source and binary directories. The ``--build-generator`` option *must* +are the source and binary directories. The ``--build-generator`` option *must* be provided to use ``--build-and-test``. If ``--test-command`` is specified then that will be run after the build is complete. Other options that affect this mode include: @@ -425,13 +427,15 @@ this mode include: should be used. e.g. Debug/Release/etc. ``--build-options`` - Add extra options to the build step. - - This option must be the last option with the exception of - ``--test-command`` + Additional options for configuring the build (i.e. for CMake, not for + the build tool). Note that if this is specified, the ``--build-options`` + keyword and its arguments must be the last option given on the command + line, with the possible exception of ``--test-command``. ``--test-command`` - The test to run with the ``--build-and-test`` option. + The command to run as the test step with the ``--build-and-test`` option. + All arguments following this keyword will be assumed to be part of the + test command line, so it must be the last option given. ``--test-timeout`` The time limit in seconds |