3. CMake options

eProsima DDS Enabler provides numerous CMake options for changing the behavior and configuration of eProsima DDS Enabler. These options allow the developer to enable/disable certain eProsima DDS Enabler settings by defining these options to ON/OFF at the CMake execution, or set the required path to certain dependencies.

Warning

These options are only for developers who installed eProsima DDS Enabler following the compilation steps described in Linux installation from sources.

3.1. General Options

Option

Description

Possible values

Default

CMAKE_BUILD_TYPE

CMake optimization build type.

Release
Debug

Release

BUILD_TESTS

Build the eProsima DDS Enabler tools and
documentation tests.

OFF
ON

OFF

COMPILE_EXAMPLES

Build the eProsima DDS Enabler examples.

OFF
ON

OFF

LOG_INFO

Activate eProsima DDS Enabler logs. It is
set to ON if CMAKE_BUILD_TYPE is set
to Debug.

OFF
ON

ON if Debug
OFF otherwise

ASAN_BUILD

Activate address sanitizer build.

OFF
ON

OFF

TSAN_BUILD

Activate thread sanitizer build.

OFF
ON

OFF

3.2. Documentation Build Option

Important

The following option is only relevant for building the local documentation project (ddsenabler_docs):

Option

Description

Possible values

Default

BUILD_DOCS

Build the eProsima DDS Enabler
documentation.

OFF
ON

OFF

Note

Once built, the generated HTML documentation is located under build/ddsenabler_docs/html