Skip to content
Snippets Groups Projects
Commit 18259fa6 authored by Craig Scott's avatar Craig Scott Committed by Kitware Robot
Browse files

Merge topic 'doc-ctest-output'


ba6d1947 Help: Add cross-references between test output size ctest variables
cdde9e5a Help: Improve wording and cross-referencing for ctest JUnit output

Acked-by: default avatarKitware Robot <kwrobot@kitware.com>
Merge-request: !6389
parents ffbd3bb4 ba6d1947
No related branches found
No related tags found
No related merge requests found
...@@ -155,12 +155,12 @@ The options are: ...@@ -155,12 +155,12 @@ The options are:
Store in the ``<result-var>`` variable -1 if there are any errors running 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. the command and prevent ctest from returning non-zero if an error occurs.
``OUTPUT_JUNIT`` ``OUTPUT_JUNIT <file>``
.. versionadded:: 3.21 .. versionadded:: 3.21
Write test results to ``<file>`` in JUnit XML format. If ``<file>`` is a 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>>`` relative path, it will be placed in the build directory. If ``<file>``
already exists it will be overwritten. Note that the resulting JUnit XML already exists, it will be overwritten. Note that the resulting JUnit XML
file is **not** uploaded to CDash because it would be redundant with file is **not** uploaded to CDash because it would be redundant with
CTest's ``Test.xml`` file. CTest's ``Test.xml`` file.
......
...@@ -137,8 +137,10 @@ Options ...@@ -137,8 +137,10 @@ Options
``--output-junit <file>`` ``--output-junit <file>``
Write test results in JUnit format. Write test results in JUnit format.
This option tells CTest to write test results to a ``<file>`` JUnit XML file. This option tells CTest to write test results to ``<file>`` in JUnit XML
If ``<file>`` already exists it will be overwritten. 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>]`` ``-N,--show-only[=<format>]``
Disable actual execution of tests. Disable actual execution of tests.
......
...@@ -9,3 +9,6 @@ If a test's output contains the literal string "CTEST_FULL_OUTPUT", ...@@ -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. the output will not be truncated and may exceed the maximum size.
.. include:: CTEST_CUSTOM_XXX.txt .. include:: CTEST_CUSTOM_XXX.txt
For controlling the output collection of passing tests, see
:variable:`CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE`.
...@@ -9,3 +9,6 @@ If a test's output contains the literal string "CTEST_FULL_OUTPUT", ...@@ -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. the output will not be truncated and may exceed the maximum size.
.. include:: CTEST_CUSTOM_XXX.txt .. include:: CTEST_CUSTOM_XXX.txt
For controlling the output collection of failing tests, see
:variable:`CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment