ctest_configure.rst 1.6 KB

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