kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ctest_build: spruce up the documentation a bit 

Adds markup and links to other sections.
This commit is contained in:
Ben Boeckel 2015-05-07 13:04:21 -04:00
parent b3ae0609db
commit 5ab896aede
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Help/command/ctest_build.rst
View File

@ -8,27 +8,27 @@ Build the project.
ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res] ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res]
[APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val]) [APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val])
Builds the given build directory and stores results in Build.xml. If Builds the given build directory and stores results in Build.xml. If no
no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. ``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. specified, the "all" target will be built.
The RETURN_VALUE option specifies a variable in which to store the The ``RETURN_VALUE`` option specifies a variable in which to store the
return value of the native build tool. The NUMBER_ERRORS and return value of the native build tool. The ``NUMBER_ERRORS`` and
NUMBER_WARNINGS options specify variables in which to store the number ``NUMBER_WARNINGS`` options specify variables in which to store the number
of build errors and warnings detected. of build errors and warnings detected.
The APPEND option marks results for append to those previously The ``APPEND`` option marks results for append to those previously
submitted to a dashboard server since the last ctest_start. Append submitted to a dashboard server since the last :command:`ctest_start`. Append
semantics are defined by the dashboard server in use. 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 that would have been printed to the console otherwise. The summary
of warnings / errors, as well as the output from the native build tool of warnings / errors, as well as the output from the native build tool
is unaffected by this option. is unaffected by this option.
If set, the contents of the variable CTEST_BUILD_FLAGS are passed as 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 additional arguments to the underlying build command. This can, e.g., be used
used to trigger a parallel build using the -j option of make. See to trigger a parallel build using the ``-j`` option of make. See
:module:`ProcessorCount` for an example. :module:`ProcessorCount` for an example.