Просмотр исходного кода

Help: Improve wording and cross-referencing for ctest JUnit output

Craig Scott 4 лет назад
Родитель
Сommit
cdde9e5a10
2 измененных файлов с 7 добавлено и 5 удалено
  1. 3 3
      Help/command/ctest_test.rst
  2. 4 2
      Help/manual/ctest.1.rst

+ 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
   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.
 

+ 4 - 2
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.