diff options
| author | Brad King <brad.king@kitware.com> | 2015-05-07 20:10:20 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-05-07 20:10:20 (GMT) |
| commit | 695d6f62d31efc8c979e80713dc550a1b1054e00 (patch) | |
| tree | cb86f349efe3f77432cfcc08cbb5dfdbae220be1 /Help/command/ctest_upload.rst | |
| parent | f8716c8b4466dd464853a5f9484ac151689c1d0c (diff) | |
| download | CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.zip CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.gz CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.bz2 | |
Help: Revise ctest_* command documentation (#15559)
Revise documentation for the major dashboard client step ``ctest_*``
commands. Modernize the documentation formatting. Add some missing
options.
Diffstat (limited to 'Help/command/ctest_upload.rst')
| -rw-r--r-- | Help/command/ctest_upload.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/Help/command/ctest_upload.rst b/Help/command/ctest_upload.rst index fcd9fe4..d9630d2 100644 --- a/Help/command/ctest_upload.rst +++ b/Help/command/ctest_upload.rst @@ -1,14 +1,18 @@ ctest_upload ------------ -Upload files to a dashboard server. +Upload files to a dashboard server as a :ref:`Dashboard Client`. :: - ctest_upload(FILES ... [QUIET]) + ctest_upload(FILES <file>... [QUIET]) -Pass a list of files to be sent along with the build results to the -dashboard server. +The options are: -The QUIET option suppresses any CTest-specific non-error output -that would have been printed to the console otherwise. +``FILES <file>...`` + Specify a list of files to be sent along with the build results to the + dashboard server. + +``QUIET`` + Suppress any CTest-specific non-error output that would have been + printed to the console otherwise. |