diff options
| author | Brad King <brad.king@kitware.com> | 2023-12-12 13:34:48 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2023-12-12 13:35:07 (GMT) |
| commit | 532c30a654cbc170b159cb80a8a597d0f74afb9c (patch) | |
| tree | 5e95543c4f442d58cd00e03c08ad2583b97e0d38 /Help/command | |
| parent | 01937b05c404aee56dae9c538c8367ab6846099f (diff) | |
| parent | 464bc12bb77c1d7cfea62392c17dbdbdc711fbea (diff) | |
| download | CMake-532c30a654cbc170b159cb80a8a597d0f74afb9c.zip CMake-532c30a654cbc170b159cb80a8a597d0f74afb9c.tar.gz CMake-532c30a654cbc170b159cb80a8a597d0f74afb9c.tar.bz2 | |
Merge topic 'Help-create_test_sourcelist'
464bc12bb7 Help/create_test_sourcelist: format arguments in the signature docs
131f9c9efa Help/create_test_sourcelist: add formatting markup
8540520902 Help/create_test_sourcelist: reflow prose
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !9059
Diffstat (limited to 'Help/command')
| -rw-r--r-- | Help/command/create_test_sourcelist.rst | 43 |
1 files changed, 21 insertions, 22 deletions
diff --git a/Help/command/create_test_sourcelist.rst b/Help/command/create_test_sourcelist.rst index 77e37c5..5f01a8b 100644 --- a/Help/command/create_test_sourcelist.rst +++ b/Help/command/create_test_sourcelist.rst @@ -5,26 +5,25 @@ Create a test driver and source list for building test programs. .. code-block:: cmake - create_test_sourcelist(sourceListName driverName - test1 test2 test3 - EXTRA_INCLUDE include.h - FUNCTION function) + create_test_sourcelist(<sourceListName> <driverName> + <tests> ... + [EXTRA_INCLUDE <include>] + [FUNCTION <function>]) -A test driver is a program that links together many small tests into a -single executable. This is useful when building static executables -with large libraries to shrink the total required size. The list of -source files needed to build the test driver will be in -``sourceListName``. ``driverName`` is the name of the test driver program. -The rest of the arguments consist of a list of test source files, can -be semicolon separated. Each test source file should have a function -in it that is the same name as the file with no extension (foo.cxx -should have int foo(int, char*[]);) ``driverName`` will be able to call -each of the tests by name on the command line. If ``EXTRA_INCLUDE`` is -specified, then the next argument is included into the generated file. -If ``FUNCTION`` is specified, then the next argument is taken as a -function name that is passed a pointer to ac and av. This can be used -to add extra command line processing to each test. The -``CMAKE_TESTDRIVER_BEFORE_TESTMAIN`` cmake variable can be set to -have code that will be placed directly before calling the test main function. -``CMAKE_TESTDRIVER_AFTER_TESTMAIN`` can be set to have code that -will be placed directly after the call to the test main function. +A test driver is a program that links together many small tests into a single +executable. This is useful when building static executables with large +libraries to shrink the total required size. The list of source files needed +to build the test driver will be in ``sourceListName``. ``driverName`` is the +name of the test driver program. The rest of the arguments consist of a list +of test source files and can be semicolon separated. Each test source file +should have a function in it that is the same name as the file with no +extension (``foo.cxx`` should have ``int foo(int, char*[]);``). ``driverName`` +will be able to call each of the tests by name on the command line. If +``EXTRA_INCLUDE`` is specified, then the next argument is included into the +generated file. If ``FUNCTION`` is specified, then the next argument is taken +as a function name that is passed pointers to ``argc`` and ``argv``. This can +be used to add extra command line processing to each test. The +``CMAKE_TESTDRIVER_BEFORE_TESTMAIN`` cmake variable can be set to have code +that will be placed directly before calling the test ``main`` function. +``CMAKE_TESTDRIVER_AFTER_TESTMAIN`` can be set to have code that will be +placed directly after the call to the test ``main`` function. |