echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Help/create_test_sourcelist: add formatting markup

Browse Source
This commit is contained in:
Ben Boeckel 2023-12-09 10:17:16 -05:00
parent 8540520902
commit 131f9c9efa
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Help/command/create_test_sourcelist.rst
View File

@ -15,15 +15,15 @@ executable. This is useful when building static executables with large
libraries to shrink the total required size. The list of source files needed 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 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 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 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 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 extension (``foo.cxx`` should have ``int foo(int, char*[]);``). ``driverName``
able to call each of the tests by name on the command line. If 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 ``EXTRA_INCLUDE`` is specified, then the next argument is included into the
generated file. If ``FUNCTION`` is specified, then the next argument is taken 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 as a function name that is passed pointers to ``argc`` and ``argv``. This can
add extra command line processing to each test. The be used to add extra command line processing to each test. The
``CMAKE_TESTDRIVER_BEFORE_TESTMAIN`` cmake variable can be set to have code ``CMAKE_TESTDRIVER_BEFORE_TESTMAIN`` cmake variable can be set to have code
that will be placed directly before calling the test main function. that will be placed directly before calling the test ``main`` function.
``CMAKE_TESTDRIVER_AFTER_TESTMAIN`` can be set to have code that will be ``CMAKE_TESTDRIVER_AFTER_TESTMAIN`` can be set to have code that will be
placed directly after the call to the test main function. placed directly after the call to the test ``main`` function.