From 1a9c83b639827146439b5efbb30a79738d828a7e Mon Sep 17 00:00:00 2001 From: Eduardo Ponz Segrelles Date: Thu, 29 Feb 2024 12:06:22 +0100 Subject: [PATCH] Documentation of FASTDDS_EXAMPLE_TESTS CMake option (#697) * Refs #19175: Remove non-existing GTEST_INDIVIDUAL option Signed-off-by: EduPonz * Refs #19175: Add documentation for FASTDDS_EXAMPLE_TESTS CMake option Signed-off-by: EduPonz --------- Signed-off-by: EduPonz --- docs/installation/configuration/cmake_options.rst | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/installation/configuration/cmake_options.rst b/docs/installation/configuration/cmake_options.rst index b77a9bc74..a06002969 100644 --- a/docs/installation/configuration/cmake_options.rst +++ b/docs/installation/configuration/cmake_options.rst @@ -301,13 +301,6 @@ The building and execution of these tests is specified by the *Fast DDS* CMake o - Description - Possible values - Default - * - :class:`GTEST_INDIVIDUAL` - - Activate the individual building of GoogleTest tests, since *Fast DDS* tests are |br| - implemented using the GoogleTest framework. However, the test are compiled |br| - if :class:`EPROSIMA_BUILD` is set to ``ON``. Therefore, if :class:`GTEST_INDIVIDUAL` is ``OFF`` and |br| - :class:`EPROSIMA_BUILD` is ``ON``, the tests are processed as a single major test. - - ``ON`` ``OFF`` - - ``OFF`` * - :class:`FASTRTPS_API_TESTS` - Enables the building of black-box tests for the verification of RTPS communications |br| using the *Fast DDS* RTPS-layer API. @@ -318,6 +311,10 @@ The building and execution of these tests is specified by the *Fast DDS* CMake o using the *Fast DDS* DDS-layer API. - ``ON`` ``OFF`` - ``OFF`` + * - :class:`FASTDDS_EXAMPLE_TESTS` + - Enables the building of example tests for the verification of the Fast DDS examples |br| + - ``ON`` ``OFF`` + - ``OFF`` * - :class:`PERFORMANCE_TESTS` - Activates the building of performance tests, except for the video test, which requires |br| both :class:`PERFORMANCE_TESTS` and :class:`VIDEO_TESTS` to be set to ``ON``.