diff options
| author | Brad King <brad.king@kitware.com> | 2018-03-14 14:49:06 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2018-03-14 14:50:29 (GMT) |
| commit | 443a52aa850c1a19d3da0608212a41a4f074d3e9 (patch) | |
| tree | a7a09a09fd308cbb0d148b7577d6c211f8fba48a /Help | |
| parent | 4fb91a886870dc9b86c7861b2bdd3e572df01624 (diff) | |
| parent | 8b43adc45c2cf7a25b739589dec2010029f91a83 (diff) | |
| download | CMake-443a52aa850c1a19d3da0608212a41a4f074d3e9.zip CMake-443a52aa850c1a19d3da0608212a41a4f074d3e9.tar.gz CMake-443a52aa850c1a19d3da0608212a41a4f074d3e9.tar.bz2 | |
Merge topic 'build_and_test_mode_docs'
8b43adc45c Help: Clarify ctest build-and-test mode options
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !1848
Diffstat (limited to 'Help')
| -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 |