ctest_configure.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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. Configure the project build tree and record results in ``Configure.xml``
  8. for submission with the :command:`ctest_submit` command.
  9. The options are:
  10. ``BUILD <build-dir>``
  11. Specify the top-level build directory. If not given, the
  12. :variable:`CTEST_BINARY_DIRECTORY` variable is used.
  13. ``SOURCE <source-dir>``
  14. Specify the source directory. If not given, the
  15. :variable:`CTEST_SOURCE_DIRECTORY` variable is used.
  16. ``APPEND``
  17. Mark results for append to those previously submitted to a
  18. dashboard server since the last :command:`ctest_start` call.
  19. Append semantics are defined by the dashboard server in use.
  20. ``OPTIONS <options>``
  21. Specify command-line arguments to pass to the configuration tool.
  22. ``RETURN_VALUE <result-var>``
  23. Store in the ``<result-var>`` variable the return value of the native
  24. configuration tool.
  25. ``QUIET``
  26. Suppress any CTest-specific non-error messages that would have
  27. otherwise been printed to the console. Output from the underlying
  28. configure command is not affected.