summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2015-05-07 17:04:21 (GMT)
committerBen Boeckel <ben.boeckel@kitware.com>2015-05-07 17:05:54 (GMT)
commit5ab896aede1efc0cd35ae73f0a9b400258fcad09 (patch)
treea333eeebec96230ac6f0c64ba771e4d128d84c77 /Help
parentb3ae0609db88d8f82f7fb4f18ddb73f3456a67d2 (diff)
downloadCMake-5ab896aede1efc0cd35ae73f0a9b400258fcad09.zip
CMake-5ab896aede1efc0cd35ae73f0a9b400258fcad09.tar.gz
CMake-5ab896aede1efc0cd35ae73f0a9b400258fcad09.tar.bz2
ctest_build: spruce up the documentation a bit
Adds markup and links to other sections.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/ctest_build.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/Help/command/ctest_build.rst b/Help/command/ctest_build.rst
index e7a54d1..7c9029e 100644
--- a/Help/command/ctest_build.rst
+++ b/Help/command/ctest_build.rst
@@ -8,27 +8,27 @@ 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
+The ``TARGET`` variable can be used to specify a build target. If none is
specified, the "all" target 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
+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.