summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_configure.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-05-07 20:10:20 (GMT)
committerBrad King <brad.king@kitware.com>2015-05-07 20:10:20 (GMT)
commit695d6f62d31efc8c979e80713dc550a1b1054e00 (patch)
treecb86f349efe3f77432cfcc08cbb5dfdbae220be1 /Help/command/ctest_configure.rst
parentf8716c8b4466dd464853a5f9484ac151689c1d0c (diff)
downloadCMake-695d6f62d31efc8c979e80713dc550a1b1054e00.zip
CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.gz
CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.bz2
Help: Revise ctest_* command documentation (#15559)
Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
Diffstat (limited to 'Help/command/ctest_configure.rst')
-rw-r--r--Help/command/ctest_configure.rst46
1 files changed, 30 insertions, 16 deletions
diff --git a/Help/command/ctest_configure.rst b/Help/command/ctest_configure.rst
index 61d9320..851c292 100644
--- a/Help/command/ctest_configure.rst
+++ b/Help/command/ctest_configure.rst
@@ -1,25 +1,39 @@
ctest_configure
---------------
-Configure the project build tree.
+Perform the :ref:`CTest Configure Step` as a :ref:`Dashboard Client`.
::
- ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND]
- [OPTIONS options] [RETURN_VALUE res] [QUIET])
+ ctest_configure([BUILD <build-dir>] [SOURCE <source-dir>] [APPEND]
+ [OPTIONS <options>] [RETURN_VALUE <result-var>] [QUIET])
-Configures the given build directory and stores results in
-Configure.xml. If no BUILD is given, the CTEST_BINARY_DIRECTORY
-variable is used. If no SOURCE is given, the CTEST_SOURCE_DIRECTORY
-variable is used. The OPTIONS argument specifies command line
-arguments to pass to the configuration tool. The RETURN_VALUE option
-specifies a variable in which to store the return value of the native
-build tool.
+Configure the project build tree and record results in ``Configure.xml``
+for submission with the :command:`ctest_submit` command.
-The APPEND option marks results for append to those previously
-submitted to a dashboard server since the last ctest_start. Append
-semantics are defined by the dashboard server in use.
+The options are:
-The QUIET option suppresses any CTest-specific non-error messages
-that would have otherwise been printed to the console. Output from
-the underlying configure command is not affected.
+``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``
+ Mark results for append to those previously submitted to a
+ dashboard server since the last :command:`ctest_start` call.
+ Append semantics are defined by the dashboard server in use.
+
+``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.
+
+``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.