From 8540520902e6acd0cfe0041a234bd612c6a46c7f Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Sat, 9 Dec 2023 10:17:16 -0500 Subject: Help/create_test_sourcelist: reflow prose --- Help/command/create_test_sourcelist.rst | 35 ++++++++++++++++----------------- 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/Help/command/create_test_sourcelist.rst b/Help/command/create_test_sourcelist.rst index 77e37c5..f6106d0 100644 --- a/Help/command/create_test_sourcelist.rst +++ b/Help/command/create_test_sourcelist.rst @@ -10,21 +10,20 @@ Create a test driver and source list for building test programs. EXTRA_INCLUDE include.h 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, 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. -- cgit v0.12 From 131f9c9efaaa4a3bd858ea40690eb6abeab4dfff Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Sat, 9 Dec 2023 10:17:16 -0500 Subject: Help/create_test_sourcelist: add formatting markup --- Help/command/create_test_sourcelist.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Help/command/create_test_sourcelist.rst b/Help/command/create_test_sourcelist.rst index f6106d0..0755bf0 100644 --- a/Help/command/create_test_sourcelist.rst +++ b/Help/command/create_test_sourcelist.rst @@ -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 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 +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 +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 +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. +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. +placed directly after the call to the test ``main`` function. -- cgit v0.12 From 464bc12bb77c1d7cfea62392c17dbdbdc711fbea Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Sat, 9 Dec 2023 23:14:39 -0500 Subject: Help/create_test_sourcelist: format arguments in the signature docs --- Help/command/create_test_sourcelist.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Help/command/create_test_sourcelist.rst b/Help/command/create_test_sourcelist.rst index 0755bf0..5f01a8b 100644 --- a/Help/command/create_test_sourcelist.rst +++ b/Help/command/create_test_sourcelist.rst @@ -5,10 +5,10 @@ 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( + ... + [EXTRA_INCLUDE ] + [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 -- cgit v0.12