Browse Source

Merge topic 'doc-ctest-output' into release-3.21

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 <[email protected]>
Merge-request: !6389
Craig Scott 4 years ago
parent
commit
9d9d527513

+ 3 - 3
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
   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>>``
-  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
   file is **not** uploaded to CDash because it would be redundant with
   CTest's ``Test.xml`` file.
   CTest's ``Test.xml`` file.
 
 

+ 4 - 2
Help/manual/ctest.1.rst

@@ -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.
- 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>]``
 ``-N,--show-only[=<format>]``
  Disable actual execution of tests.
  Disable actual execution of tests.

+ 3 - 0
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.
 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`.

+ 3 - 0
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.
 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`.