| Ryan Prichard | 7aea7e9 | 2022-01-13 17:30:17 -0800 | [diff] [blame] | 1 | ctest_configure |
| 2 | --------------- |
| 3 | |
| 4 | Perform the :ref:`CTest Configure Step` as a :ref:`Dashboard Client`. |
| 5 | |
| 6 | :: |
| 7 | |
| 8 | ctest_configure([BUILD <build-dir>] [SOURCE <source-dir>] [APPEND] |
| 9 | [OPTIONS <options>] [RETURN_VALUE <result-var>] [QUIET] |
| 10 | [CAPTURE_CMAKE_ERROR <result-var>]) |
| 11 | |
| 12 | Configure the project build tree and record results in ``Configure.xml`` |
| 13 | for submission with the :command:`ctest_submit` command. |
| 14 | |
| 15 | The options are: |
| 16 | |
| 17 | ``BUILD <build-dir>`` |
| 18 | Specify the top-level build directory. If not given, the |
| 19 | :variable:`CTEST_BINARY_DIRECTORY` variable is used. |
| 20 | |
| 21 | ``SOURCE <source-dir>`` |
| 22 | Specify the source directory. If not given, the |
| 23 | :variable:`CTEST_SOURCE_DIRECTORY` variable is used. |
| 24 | |
| 25 | ``APPEND`` |
| 26 | Mark ``Configure.xml`` for append to results previously submitted to a |
| 27 | dashboard server since the last :command:`ctest_start` call. |
| 28 | Append semantics are defined by the dashboard server in use. |
| 29 | This does *not* cause results to be appended to a ``.xml`` file |
| 30 | produced by a previous call to this command. |
| 31 | |
| 32 | ``OPTIONS <options>`` |
| 33 | Specify command-line arguments to pass to the configuration tool. |
| 34 | |
| 35 | ``RETURN_VALUE <result-var>`` |
| 36 | Store in the ``<result-var>`` variable the return value of the native |
| 37 | configuration tool. |
| 38 | |
| 39 | ``CAPTURE_CMAKE_ERROR <result-var>`` |
| 40 | .. versionadded:: 3.7 |
| 41 | |
| 42 | Store in the ``<result-var>`` variable -1 if there are any errors running |
| 43 | the command and prevent ctest from returning non-zero if an error occurs. |
| 44 | |
| 45 | ``QUIET`` |
| 46 | .. versionadded:: 3.3 |
| 47 | |
| 48 | Suppress any CTest-specific non-error messages that would have |
| 49 | otherwise been printed to the console. Output from the underlying |
| 50 | configure command is not affected. |