kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/command/ctest_configure.rst

47 lines
1.6 KiB
ReStructuredText
Raw Normal View History

Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
ctest_configure
---------------
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
Perform the :ref:`CTest Configure Step` as a :ref:`Dashboard Client`.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
::
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
ctest_configure([BUILD <build-dir>] [SOURCE <source-dir>] [APPEND]
CTest: Add CAPTURE_CMAKE_ERROR val to `ctest_*` commands If a `ctest_*` command has CAPTURE_CMAKE_ERROR then any errors generated by cmake during that command will cause the value to be assigned `-1`. This will prevent a `ctest -S` script from returning non-zero unless the script explicitly calls `message(FATAL_ERROR)`.
2016-07-28 22:12:43 +03:00
[OPTIONS <options>] [RETURN_VALUE <result-var>] [QUIET]
[CAPTURE_CMAKE_ERROR <result-var>])
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
Configure the project build tree and record results in ``Configure.xml``
for submission with the :command:`ctest_submit` command.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
The options are:
ctest_configure: Add QUIET option
2015-02-17 20:38:52 +03:00
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
``BUILD <build-dir>``
Specify the top-level build directory. If not given, the
:variable:`CTEST_BINARY_DIRECTORY` variable is used.
``SOURCE <source-dir>``
Specify the source directory. If not given, the
:variable:`CTEST_SOURCE_DIRECTORY` variable is used.
``APPEND``
Help: Clarify `ctest_*` APPEND option behavior Explicitly state that this marks the `.xml` to tell the dashboard server to append it to previously submitted results and that it does not cause results to be appended to the `.xml` file.
2016-10-14 21:42:48 +03:00
Mark ``Configure.xml`` for append to results previously submitted to a
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
dashboard server since the last :command:`ctest_start` call.
Append semantics are defined by the dashboard server in use.
Help: Clarify `ctest_*` APPEND option behavior Explicitly state that this marks the `.xml` to tell the dashboard server to append it to previously submitted results and that it does not cause results to be appended to the `.xml` file.
2016-10-14 21:42:48 +03:00
This does *not* cause results to be appended to a ``.xml`` file
produced by a previous call to this command.
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
``OPTIONS <options>``
Specify command-line arguments to pass to the configuration tool.
``RETURN_VALUE <result-var>``
Store in the ``<result-var>`` variable the return value of the native
configuration tool.
CTest: Add CAPTURE_CMAKE_ERROR val to `ctest_*` commands If a `ctest_*` command has CAPTURE_CMAKE_ERROR then any errors generated by cmake during that command will cause the value to be assigned `-1`. This will prevent a `ctest -S` script from returning non-zero unless the script explicitly calls `message(FATAL_ERROR)`.
2016-07-28 22:12:43 +03:00
``CAPTURE_CMAKE_ERROR <result-var>``
Store in the ``<result-var>`` variable -1 if there are any errors running
the command and prevent ctest from returning non-zero if an error occurs.
Help: Revise ctest_* command documentation (#15559) Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
2015-05-07 23:10:20 +03:00
``QUIET``
Suppress any CTest-specific non-error messages that would have
otherwise been printed to the console. Output from the underlying
configure command is not affected.