summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_configure.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/ctest_configure.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
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.
Diffstat (limited to 'Help/command/ctest_configure.rst')
-rw-r--r--Help/command/ctest_configure.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/Help/command/ctest_configure.rst b/Help/command/ctest_configure.rst
new file mode 100644
index 0000000..2c4e305
--- /dev/null
+++ b/Help/command/ctest_configure.rst
@@ -0,0 +1,21 @@
+ctest_configure
+---------------
+
+Configure the project build tree.
+
+::
+
+ ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND]
+ [OPTIONS options] [RETURN_VALUE res])
+
+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.
+
+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.