diff options
| author | Craig Scott <craig.scott@crascit.com> | 2021-07-26 11:47:48 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2021-07-26 11:48:02 (GMT) |
| commit | 18259fa689aca9270ad93a43afe88e390a855cfd (patch) | |
| tree | 03b3515cda2105720ae38b99fa33b91b880df46d /Help | |
| parent | ffbd3bb42f99be35218ff34040f795fbc66eb932 (diff) | |
| parent | ba6d1947b6ef6186e84ee589d792bf9437f0d417 (diff) | |
| download | CMake-18259fa689aca9270ad93a43afe88e390a855cfd.zip CMake-18259fa689aca9270ad93a43afe88e390a855cfd.tar.gz CMake-18259fa689aca9270ad93a43afe88e390a855cfd.tar.bz2 | |
Merge topic 'doc-ctest-output'
ba6d1947b6 Help: Add cross-references between test output size ctest variables
cdde9e5a10 Help: Improve wording and cross-referencing for ctest JUnit output
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6389
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/ctest_test.rst | 6 | ||||
| -rw-r--r-- | Help/manual/ctest.1.rst | 6 | ||||
| -rw-r--r-- | Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst | 3 | ||||
| -rw-r--r-- | Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst | 3 |
4 files changed, 13 insertions, 5 deletions
diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst index 9c4df22..4e5484f 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 ab819f9..03d8bf6 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. diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst index 9f145c1..7e7d431 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst @@ -9,3 +9,6 @@ If a test's output contains the literal string "CTEST_FULL_OUTPUT", the output will not be truncated and may exceed the maximum size. .. include:: CTEST_CUSTOM_XXX.txt + +For controlling the output collection of passing tests, see +:variable:`CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE`. diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst index 71ecf52..64367f9 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst @@ -9,3 +9,6 @@ If a test's output contains the literal string "CTEST_FULL_OUTPUT", the output will not be truncated and may exceed the maximum size. .. include:: CTEST_CUSTOM_XXX.txt + +For controlling the output collection of failing tests, see +:variable:`CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE`. |