Commit 4da5a227 authored by Ben Boeckel's avatar Ben Boeckel Committed by Brad King

Help: document CTEST_CUSTOM_* variables

parent 70c0cc72
......@@ -374,8 +374,23 @@ Variables for CTest
/variable/CTEST_COVERAGE_COMMAND
/variable/CTEST_COVERAGE_EXTRA_FLAGS
/variable/CTEST_CURL_OPTIONS
/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE
/variable/CTEST_CUSTOM_ERROR_EXCEPTION
/variable/CTEST_CUSTOM_ERROR_MATCH
/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT
/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT
/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE
/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS
/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS
/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE
/variable/CTEST_CUSTOM_MEMCHECK_IGNORE
/variable/CTEST_CUSTOM_POST_MEMCHECK
/variable/CTEST_CUSTOM_POST_TEST
/variable/CTEST_CUSTOM_PRE_MEMCHECK
/variable/CTEST_CUSTOM_PRE_TEST
/variable/CTEST_CUSTOM_TEST_IGNORE
/variable/CTEST_CUSTOM_WARNING_EXCEPTION
/variable/CTEST_CUSTOM_WARNING_MATCH
/variable/CTEST_CVS_CHECKOUT
/variable/CTEST_CVS_COMMAND
/variable/CTEST_CVS_UPDATE_OPTIONS
......@@ -385,6 +400,7 @@ Variables for CTest
/variable/CTEST_DROP_SITE_CDASH
/variable/CTEST_DROP_SITE_PASSWORD
/variable/CTEST_DROP_SITE_USER
/variable/CTEST_EXTRA_COVERAGE_GLOB
/variable/CTEST_GIT_COMMAND
/variable/CTEST_GIT_UPDATE_CUSTOM
/variable/CTEST_GIT_UPDATE_OPTIONS
......
CTEST_CUSTOM_COVERAGE_EXCLUDE
-----------------------------
A list of regular expressions which will be used to exclude files by their
path from coverage output by the :command:`ctest_coverage` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_ERROR_EXCEPTION
----------------------------
A list of regular expressions which will be used to exclude when detecting
error messages in build outputs by the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_ERROR_MATCH
------------------------
A list of regular expressions which will be used to detect error messages in
build outputs by the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_ERROR_POST_CONTEXT
-------------------------------
The number of lines to include as context which follow an error message by the
:command:`ctest_test` command. The default is 10.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_ERROR_PRE_CONTEXT
------------------------------
The number of lines to include as context which precede an error message by
the :command:`ctest_test` command. The default is 10.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE
--------------------------------------------
Specify the maximum amount of output from a failed test that will
be collected by the :command:`ctest_test` command. If not set,
the default is 300 KiB.
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
(300 KiB).
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS
-------------------------------------
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.
Defaults to 50.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS
---------------------------------------
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.
Defaults to 50.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE
--------------------------------------------
Specify the maximum amount of output from a passed test that will
be collected by the :command:`ctest_test` command. If not set,
the default is 1 KiB.
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
(1 KiB).
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_MEMCHECK_IGNORE
----------------------------
A list of regular expressions to use to exclude tests during the
:command:`ctest_memcheck` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_POST_MEMCHECK
--------------------------
A list of commands to run at the end of the :command:`ctest_memcheck` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_POST_TEST
----------------------
A list of commands to run at the end of the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_PRE_MEMCHECK
-------------------------
A list of commands to run at the start of the :command:`ctest_memcheck`
command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_PRE_TEST
----------------------
A list of commands to run at the start of the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_TEST_IGNORE
------------------------
A list of regular expressions to use to exclude tests during the
:command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_WARNING_EXCEPTION
------------------------------
A list of regular expressions which will be used to exclude when detecting
warning messages in build outputs by the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt
CTEST_CUSTOM_WARNING_MATCH
--------------------------
A list of regular expressions which will be used to detect warning messages in
build outputs by the :command:`ctest_test` command.
.. include:: CTEST_CUSTOM_XXX.txt
It is initialized by :manual:`ctest(1)`, but may be edited in a ``CTestCustom``
file. See :command:`ctest_read_custom_files` documentation.
CTEST_EXTRA_COVERAGE_GLOB
-------------------------
A list of regular expressions which will be used to find files which should be
covered by the :command:`ctest_coverage` command.
.. include:: CTEST_CUSTOM_XXX.txt
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment