summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-05-07 18:32:11 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2015-05-07 18:32:11 (GMT)
commitee1ddec4c19488216289dfd26998091b695bf3ee (patch)
treec6f6083d0d39c1ffdc8096ccd9437f66086f0770 /Help
parente4e09dee92da27218b96f3add3036abb701c8352 (diff)
parent5731fb2e5e30747a46b1e328539310d059115ad9 (diff)
downloadCMake-ee1ddec4c19488216289dfd26998091b695bf3ee.zip
CMake-ee1ddec4c19488216289dfd26998091b695bf3ee.tar.gz
CMake-ee1ddec4c19488216289dfd26998091b695bf3ee.tar.bz2
Merge topic 'update-ctest_build-docs'
5731fb2e ctest_build: mention CTEST_BUILD_COMMAND in the docs 753da8c6 ctest_build: update the default target documentation 5ab896ae ctest_build: spruce up the documentation a bit
Diffstat (limited to 'Help')
-rw-r--r--Help/command/ctest_build.rst30
1 files changed, 16 insertions, 14 deletions
diff --git a/Help/command/ctest_build.rst b/Help/command/ctest_build.rst
index e7a54d1..5c0a4e9 100644
--- a/Help/command/ctest_build.rst
+++ b/Help/command/ctest_build.rst
@@ -8,27 +8,29 @@ Build the project.
ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res]
[APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val])
-Builds the given build directory and stores results in Build.xml. If
-no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used.
+Builds the given build directory and stores results in Build.xml. If no
+``BUILD`` is given, the :variable:`CTEST_BINARY_DIRECTORY` variable is used.
-The TARGET variable can be used to specify a build target. If none is
-specified, the "all" target will be built.
+The ``TARGET`` variable can be used to specify a build target. If none is
+specified, the default target ("ALL_BUILD" for Visual Studio generators and
+"all" in others) will be built.
-The RETURN_VALUE option specifies a variable in which to store the
-return value of the native build tool. The NUMBER_ERRORS and
-NUMBER_WARNINGS options specify variables in which to store the number
+The ``RETURN_VALUE`` option specifies a variable in which to store the
+return value of the native build tool. The ``NUMBER_ERRORS`` and
+``NUMBER_WARNINGS`` options specify variables in which to store the number
of build errors and warnings detected.
-The APPEND option marks results for append to those previously
-submitted to a dashboard server since the last ctest_start. Append
+The ``APPEND`` option marks results for append to those previously
+submitted to a dashboard server since the last :command:`ctest_start`. Append
semantics are defined by the dashboard server in use.
-The QUIET option suppresses any CTest-specific non-error output
+The ``QUIET`` option suppresses any CTest-specific non-error output
that would have been printed to the console otherwise. The summary
of warnings / errors, as well as the output from the native build tool
is unaffected by this option.
-If set, the contents of the variable CTEST_BUILD_FLAGS are passed as
-additional arguments to the underlying build command. This can e.g. be
-used to trigger a parallel build using the -j option of make. See
-:module:`ProcessorCount` for an example.
+If set, the contents of the variable ``CTEST_BUILD_COMMAND`` is used to build
+the project. In addition, if set, the contents of the variable
+``CTEST_BUILD_FLAGS`` are passed as additional arguments to the underlying
+build command. This can, e.g., be used to trigger a parallel build using the
+``-j`` option of make. See :module:`ProcessorCount` for an example.