mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-06 05:40:54 -06:00
c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
86 lines
2.9 KiB
ReStructuredText
86 lines
2.9 KiB
ReStructuredText
ctest_build
|
|
-----------
|
|
|
|
Perform the :ref:`CTest Build Step` as a :ref:`Dashboard Client`.
|
|
|
|
::
|
|
|
|
ctest_build([BUILD <build-dir>] [APPEND]
|
|
[CONFIGURATION <config>]
|
|
[FLAGS <flags>]
|
|
[PROJECT_NAME <project-name>]
|
|
[TARGET <target-name>]
|
|
[NUMBER_ERRORS <num-err-var>]
|
|
[NUMBER_WARNINGS <num-warn-var>]
|
|
[RETURN_VALUE <result-var>]
|
|
[CAPTURE_CMAKE_ERROR <result-var>]
|
|
)
|
|
|
|
Build the project and store results in ``Build.xml``
|
|
for submission with the :command:`ctest_submit` command.
|
|
|
|
The :variable:`CTEST_BUILD_COMMAND` variable may be set to explicitly
|
|
specify the build command line. Otherwise the build command line is
|
|
computed automatically based on the options given.
|
|
|
|
The options are:
|
|
|
|
``BUILD <build-dir>``
|
|
Specify the top-level build directory. If not given, the
|
|
:variable:`CTEST_BINARY_DIRECTORY` variable is used.
|
|
|
|
``APPEND``
|
|
Mark ``Build.xml`` for append to results previously submitted to a
|
|
dashboard server since the last :command:`ctest_start` call.
|
|
Append semantics are defined by the dashboard server in use.
|
|
This does *not* cause results to be appended to a ``.xml`` file
|
|
produced by a previous call to this command.
|
|
|
|
``CONFIGURATION <config>``
|
|
Specify the build configuration (e.g. ``Debug``). If not
|
|
specified the ``CTEST_BUILD_CONFIGURATION`` variable will be checked.
|
|
Otherwise the ``-C <cfg>`` option given to the :manual:`ctest(1)`
|
|
command will be used, if any.
|
|
|
|
``FLAGS <flags>``
|
|
Pass additional arguments to the underlying build command.
|
|
If not specified the ``CTEST_BUILD_FLAGS`` variable will be checked.
|
|
This can, e.g., be used to trigger a parallel build using the
|
|
``-j`` option of make. See the :module:`ProcessorCount` module
|
|
for an example.
|
|
|
|
``PROJECT_NAME <project-name>``
|
|
Ignored since CMake 3.0.
|
|
|
|
.. versionadded:: 3.14
|
|
This value is no longer required.
|
|
|
|
``TARGET <target-name>``
|
|
Specify the name of a target to build. If not specified the
|
|
``CTEST_BUILD_TARGET`` variable will be checked. Otherwise the
|
|
default target will be built. This is the "all" target
|
|
(called ``ALL_BUILD`` in :ref:`Visual Studio Generators`).
|
|
|
|
``NUMBER_ERRORS <num-err-var>``
|
|
Store the number of build errors detected in the given variable.
|
|
|
|
``NUMBER_WARNINGS <num-warn-var>``
|
|
Store the number of build warnings detected in the given variable.
|
|
|
|
``RETURN_VALUE <result-var>``
|
|
Store the return value of the native build tool in the given variable.
|
|
|
|
``CAPTURE_CMAKE_ERROR <result-var>``
|
|
.. versionadded:: 3.7
|
|
|
|
Store in the ``<result-var>`` variable -1 if there are any errors running
|
|
the command and prevent ctest from returning non-zero if an error occurs.
|
|
|
|
``QUIET``
|
|
.. versionadded:: 3.3
|
|
|
|
Suppress 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.
|