mirror of
https://github.com/Kitware/CMake.git
synced 2026-03-05 22:28:35 -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
131 lines
3.9 KiB
ReStructuredText
131 lines
3.9 KiB
ReStructuredText
ctest_submit
|
|
------------
|
|
|
|
Perform the :ref:`CTest Submit Step` as a :ref:`Dashboard Client`.
|
|
|
|
::
|
|
|
|
ctest_submit([PARTS <part>...] [FILES <file>...]
|
|
[SUBMIT_URL <url>]
|
|
[BUILD_ID <result-var>]
|
|
[HTTPHEADER <header>]
|
|
[RETRY_COUNT <count>]
|
|
[RETRY_DELAY <delay>]
|
|
[RETURN_VALUE <result-var>]
|
|
[CAPTURE_CMAKE_ERROR <result-var>]
|
|
[QUIET]
|
|
)
|
|
|
|
Submit results to a dashboard server.
|
|
By default all available parts are submitted.
|
|
|
|
The options are:
|
|
|
|
``PARTS <part>...``
|
|
Specify a subset of parts to submit. Valid part names are::
|
|
|
|
Start = nothing
|
|
Update = ctest_update results, in Update.xml
|
|
Configure = ctest_configure results, in Configure.xml
|
|
Build = ctest_build results, in Build.xml
|
|
Test = ctest_test results, in Test.xml
|
|
Coverage = ctest_coverage results, in Coverage.xml
|
|
MemCheck = ctest_memcheck results, in DynamicAnalysis.xml
|
|
Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml
|
|
ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES
|
|
Upload = Files prepared for upload by ctest_upload(), in Upload.xml
|
|
Submit = nothing
|
|
Done = Build is complete, in Done.xml
|
|
|
|
``FILES <file>...``
|
|
Specify an explicit list of specific files to be submitted.
|
|
Each individual file must exist at the time of the call.
|
|
|
|
``SUBMIT_URL <url>``
|
|
.. versionadded:: 3.14
|
|
|
|
The ``http`` or ``https`` URL of the dashboard server to send the submission
|
|
to. If not given, the :variable:`CTEST_SUBMIT_URL` variable is used.
|
|
|
|
``BUILD_ID <result-var>``
|
|
.. versionadded:: 3.15
|
|
|
|
Store in the ``<result-var>`` variable the ID assigned to this build by
|
|
CDash.
|
|
|
|
``HTTPHEADER <HTTP-header>``
|
|
.. versionadded:: 3.9
|
|
|
|
Specify HTTP header to be included in the request to CDash during submission.
|
|
For example, CDash can be configured to only accept submissions from
|
|
authenticated clients. In this case, you should provide a bearer token in your
|
|
header:
|
|
|
|
.. code-block:: cmake
|
|
|
|
ctest_submit(HTTPHEADER "Authorization: Bearer <auth-token>")
|
|
|
|
This suboption can be repeated several times for multiple headers.
|
|
|
|
``RETRY_COUNT <count>``
|
|
Specify how many times to retry a timed-out submission.
|
|
|
|
``RETRY_DELAY <delay>``
|
|
Specify how long (in seconds) to wait after a timed-out submission
|
|
before attempting to re-submit.
|
|
|
|
``RETURN_VALUE <result-var>``
|
|
Store in the ``<result-var>`` variable ``0`` for success and
|
|
non-zero on failure.
|
|
|
|
``CAPTURE_CMAKE_ERROR <result-var>``
|
|
.. versionadded:: 3.13
|
|
|
|
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 all non-error messages that would have otherwise been
|
|
printed to the console.
|
|
|
|
Submit to CDash Upload API
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. versionadded:: 3.2
|
|
|
|
::
|
|
|
|
ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>]
|
|
[SUBMIT_URL <url>]
|
|
[BUILD_ID <result-var>]
|
|
[HTTPHEADER <header>]
|
|
[RETRY_COUNT <count>]
|
|
[RETRY_DELAY <delay>]
|
|
[RETURN_VALUE <result-var>]
|
|
[QUIET])
|
|
|
|
This second signature is used to upload files to CDash via the CDash
|
|
file upload API. The API first sends a request to upload to CDash along
|
|
with a content hash of the file. If CDash does not already have the file,
|
|
then it is uploaded. Along with the file, a CDash type string is specified
|
|
to tell CDash which handler to use to process the data.
|
|
|
|
This signature interprets options in the same way as the first one.
|
|
|
|
.. versionadded:: 3.8
|
|
Added ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options.
|
|
|
|
.. versionadded:: 3.9
|
|
Added ``HTTPHEADER`` option.
|
|
|
|
.. versionadded:: 3.13
|
|
Added ``RETURN_VALUE`` option.
|
|
|
|
.. versionadded:: 3.14
|
|
Added ``SUBMIT_URL`` option.
|
|
|
|
.. versionadded:: 3.15
|
|
Added ``BUILD_ID`` option.
|