diff options
| author | Craig Scott <craig.scott@crascit.com> | 2021-07-25 21:31:48 +1000 |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2021-07-25 21:37:29 +1000 |
| commit | cdde9e5a10f22caa925d5391f406c6eaf3333f70 (patch) | |
| tree | 5619d46b939ff3a0c62398358ee94121b29abdae /Help | |
| parent | e98bfa484f0e36a064fd83fc290751960a9facdd (diff) | |
| download | cmake-cdde9e5a10f22caa925d5391f406c6eaf3333f70.tar.gz | |
Help: Improve wording and cross-referencing for ctest JUnit output
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/ctest_test.rst | 6 | ||||
| -rw-r--r-- | Help/manual/ctest.1.rst | 6 |
2 files changed, 7 insertions, 5 deletions
diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 2104c47c62..89787d1332 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -155,12 +155,12 @@ The options are: 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. -``OUTPUT_JUNIT`` +``OUTPUT_JUNIT <file>`` .. versionadded:: 3.21 Write test results to ``<file>`` in JUnit XML format. If ``<file>`` is a - relative path it will be placed in the build directory. If ``<file>>`` - already exists it will be overwritten. Note that the resulting JUnit XML + relative path, it will be placed in the build directory. If ``<file>`` + already exists, it will be overwritten. Note that the resulting JUnit XML file is **not** uploaded to CDash because it would be redundant with CTest's ``Test.xml`` file. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index ab819f94ef..03d8bf6c80 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -137,8 +137,10 @@ Options ``--output-junit <file>`` Write test results in JUnit format. - This option tells CTest to write test results to a ``<file>`` JUnit XML file. - If ``<file>`` already exists it will be overwritten. + This option tells CTest to write test results to ``<file>`` in JUnit XML + format. If ``<file>`` already exists, it will be overwritten. If using the + ``-S`` option to run a dashboard script, use the ``OUTPUT_JUNIT`` keyword + with the :command:`ctest_test` command instead. ``-N,--show-only[=<format>]`` Disable actual execution of tests. |