1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-20 12:53:55 +08:00

Help: Fix .. versionadded directives for CTEST_CUSTOM_* variables

CTEST_CUSTOM_* variables predate 3.0, but the docs were only added in 3.4.

Issue: #19715
This commit is contained in:
Nikita Nemkin
2020-11-22 03:15:02 +05:00
parent 4549027a09
commit 6e7625989c
17 changed files with 0 additions and 34 deletions

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_COVERAGE_EXCLUDE CTEST_CUSTOM_COVERAGE_EXCLUDE
----------------------------- -----------------------------
.. versionadded:: 3.4
A list of regular expressions which will be used to exclude files by their A list of regular expressions which will be used to exclude files by their
path from coverage output by the :command:`ctest_coverage` command. path from coverage output by the :command:`ctest_coverage` command.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_ERROR_EXCEPTION CTEST_CUSTOM_ERROR_EXCEPTION
---------------------------- ----------------------------
.. versionadded:: 3.4
A list of regular expressions which will be used to exclude when detecting A list of regular expressions which will be used to exclude when detecting
error messages in build outputs by the :command:`ctest_test` command. error messages in build outputs by the :command:`ctest_test` command.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_ERROR_MATCH CTEST_CUSTOM_ERROR_MATCH
------------------------ ------------------------
.. versionadded:: 3.4
A list of regular expressions which will be used to detect error messages in A list of regular expressions which will be used to detect error messages in
build outputs by the :command:`ctest_test` command. build outputs by the :command:`ctest_test` command.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_ERROR_POST_CONTEXT CTEST_CUSTOM_ERROR_POST_CONTEXT
------------------------------- -------------------------------
.. versionadded:: 3.4
The number of lines to include as context which follow an error message by the The number of lines to include as context which follow an error message by the
:command:`ctest_test` command. The default is 10. :command:`ctest_test` command. The default is 10.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_ERROR_PRE_CONTEXT CTEST_CUSTOM_ERROR_PRE_CONTEXT
------------------------------ ------------------------------
.. versionadded:: 3.4
The number of lines to include as context which precede an error message by The number of lines to include as context which precede an error message by
the :command:`ctest_test` command. The default is 10. the :command:`ctest_test` command. The default is 10.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE
-------------------------------------------- --------------------------------------------
.. versionadded:: 3.4
When saving a failing test's output, this is the maximum size, in bytes, that When saving a failing test's output, this is the maximum size, in bytes, that
will be collected by the :command:`ctest_test` command. Defaults to 307200 will be collected by the :command:`ctest_test` command. Defaults to 307200
(300 KiB). (300 KiB).

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS
------------------------------------- -------------------------------------
.. versionadded:: 3.4
The maximum number of errors in a single build step which will be detected. The maximum number of errors in a single build step which will be detected.
After this, the :command:`ctest_test` command will truncate the output. After this, the :command:`ctest_test` command will truncate the output.
Defaults to 50. Defaults to 50.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS
--------------------------------------- ---------------------------------------
.. versionadded:: 3.4
The maximum number of warnings in a single build step which will be detected. The maximum number of warnings in a single build step which will be detected.
After this, the :command:`ctest_test` command will truncate the output. After this, the :command:`ctest_test` command will truncate the output.
Defaults to 50. Defaults to 50.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE
-------------------------------------------- --------------------------------------------
.. versionadded:: 3.4
When saving a passing test's output, this is the maximum size, in bytes, that When saving a passing test's output, this is the maximum size, in bytes, that
will be collected by the :command:`ctest_test` command. Defaults to 1024 will be collected by the :command:`ctest_test` command. Defaults to 1024
(1 KiB). (1 KiB).

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_MEMCHECK_IGNORE CTEST_CUSTOM_MEMCHECK_IGNORE
---------------------------- ----------------------------
.. versionadded:: 3.4
A list of regular expressions to use to exclude tests during the A list of regular expressions to use to exclude tests during the
:command:`ctest_memcheck` command. :command:`ctest_memcheck` command.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_POST_MEMCHECK CTEST_CUSTOM_POST_MEMCHECK
-------------------------- --------------------------
.. versionadded:: 3.4
A list of commands to run at the end of the :command:`ctest_memcheck` command. A list of commands to run at the end of the :command:`ctest_memcheck` command.
.. include:: CTEST_CUSTOM_XXX.txt .. include:: CTEST_CUSTOM_XXX.txt

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_POST_TEST CTEST_CUSTOM_POST_TEST
---------------------- ----------------------
.. versionadded:: 3.4
A list of commands to run at the end of the :command:`ctest_test` command. A list of commands to run at the end of the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt .. include:: CTEST_CUSTOM_XXX.txt

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_PRE_MEMCHECK CTEST_CUSTOM_PRE_MEMCHECK
------------------------- -------------------------
.. versionadded:: 3.4
A list of commands to run at the start of the :command:`ctest_memcheck` A list of commands to run at the start of the :command:`ctest_memcheck`
command. command.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_PRE_TEST CTEST_CUSTOM_PRE_TEST
---------------------- ----------------------
.. versionadded:: 3.4
A list of commands to run at the start of the :command:`ctest_test` command. A list of commands to run at the start of the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt .. include:: CTEST_CUSTOM_XXX.txt

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_TESTS_IGNORE CTEST_CUSTOM_TESTS_IGNORE
------------------------- -------------------------
.. versionadded:: 3.14
A list of regular expressions to use to exclude tests during the A list of regular expressions to use to exclude tests during the
:command:`ctest_test` command. :command:`ctest_test` command.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_WARNING_EXCEPTION CTEST_CUSTOM_WARNING_EXCEPTION
------------------------------ ------------------------------
.. versionadded:: 3.4
A list of regular expressions which will be used to exclude when detecting A list of regular expressions which will be used to exclude when detecting
warning messages in build outputs by the :command:`ctest_build` command. warning messages in build outputs by the :command:`ctest_build` command.

View File

@@ -1,8 +1,6 @@
CTEST_CUSTOM_WARNING_MATCH CTEST_CUSTOM_WARNING_MATCH
-------------------------- --------------------------
.. versionadded:: 3.4
A list of regular expressions which will be used to detect warning messages in A list of regular expressions which will be used to detect warning messages in
build outputs by the :command:`ctest_build` command. build outputs by the :command:`ctest_build` command.