Skip to content

Commit

Permalink
Documentation of FASTDDS_EXAMPLE_TESTS CMake option (#697)
Browse files Browse the repository at this point in the history
* Refs #19175: Remove non-existing GTEST_INDIVIDUAL option

Signed-off-by: EduPonz <[email protected]>

* Refs #19175: Add documentation for FASTDDS_EXAMPLE_TESTS CMake option

Signed-off-by: EduPonz <[email protected]>

---------

Signed-off-by: EduPonz <[email protected]>
  • Loading branch information
EduPonz authored Feb 29, 2024
1 parent 9bb4e10 commit 1a9c83b
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions docs/installation/configuration/cmake_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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``.
Expand Down

0 comments on commit 1a9c83b

Please sign in to comment.