ctest_configure.rst 1.6 KB
Newer Older
1 2 3
ctest_configure
---------------

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 10
                  [OPTIONS <options>] [RETURN_VALUE <result-var>] [QUIET]
                  [CAPTURE_CMAKE_ERROR <result-var>])
11

12 13
Configure the project build tree and record results in ``Configure.xml``
for submission with the :command:`ctest_submit` command.
14

15
The options are:
16

17 18 19 20 21 22 23 24 25
``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``
26
  Mark ``Configure.xml`` for append to results previously submitted to a
27 28
  dashboard server since the last :command:`ctest_start` call.
  Append semantics are defined by the dashboard server in use.
29 30
  This does *not* cause results to be appended to a ``.xml`` file
  produced by a previous call to this command.
31 32 33 34 35 36 37 38

``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.

39 40 41 42
``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.

43 44 45 46
``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.