From cdde9e5a10f22caa925d5391f406c6eaf3333f70 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sun, 25 Jul 2021 21:31:48 +1000 Subject: Help: Improve wording and cross-referencing for ctest JUnit output --- Help/command/ctest_test.rst | 6 +++--- 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 2104c47..89787d1 100644 --- a/Help/command/ctest_test.rst +++ b/Help/command/ctest_test.rst @@ -155,12 +155,12 @@ The options are: Store in the ```` 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 `` .. versionadded:: 3.21 Write test results to ```` in JUnit XML format. If ```` is a - relative path it will be placed in the build directory. If ``>`` - already exists it will be overwritten. Note that the resulting JUnit XML + relative path, it will be placed in the build directory. If ```` + 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 `` Write test results in JUnit format. - This option tells CTest to write test results to a ```` JUnit XML file. - If ```` already exists it will be overwritten. + This option tells CTest to write test results to ```` in JUnit XML + format. If ```` 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[=]`` Disable actual execution of tests. -- cgit v0.12 From ba6d1947b6ef6186e84ee589d792bf9437f0d417 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sun, 25 Jul 2021 21:37:59 +1000 Subject: Help: Add cross-references between test output size ctest variables --- Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst | 3 +++ Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst | 3 +++ 2 files changed, 6 insertions(+) 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`. -- cgit v0.12