Skip to content

Document CMake option APPEND_PROJECT_NAME_TO_INCLUDEDIR #355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 14, 2022
Merged

Document CMake option APPEND_PROJECT_NAME_TO_INCLUDEDIR #355

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
37aa24b
Document CMake option APPEND_PROJECT_NAME_TO_INCLUDEDIR
sloretz Mar 10, 2022
6cd21d1
Force line breaks
sloretz Mar 11, 2022
15275c3
Adjust line lenghts to avoid right scrolling on table
EduPonz Mar 14, 2022
2ffc2c8
Appy suggestions
EduPonz Mar 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 24 additions & 17 deletions docs/installation/configuration/cmake_options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ dependency on other options.
- ``OFF``
* - :class:`EPROSIMA_BUILD`
- Activates internal *Fast DDS* builds.
It is set to ``ON`` if :class:`EPROSIMA_INSTALLER` is ``ON``. |br|
Setting :class:`EPROSIMA_BUILD` to ``ON`` has the following effects on other options:
It is set to ``ON`` if :class:`EPROSIMA_INSTALLER` is |br|
``ON``. Setting :class:`EPROSIMA_BUILD` to ``ON`` has the following effects on other |br|
options:

- :class:`INTERNAL_DEBUG` is set to ``ON``.
- :class:`COMPILE_EXAMPLES` is set to ``ON`` if :class:`EPROSIMA_INSTALLER` is ``OFF``.
Expand All @@ -58,36 +59,36 @@ dependency on other options.
- ``ON`` ``OFF``
- ``OFF``
* - :class:`BUILD_SHARED_LIBS`
- Builds internal libraries as shared libraries, i.e. cause :func:`add_library` CMake function |br|
to create shared libraries if on. All libraries are built shared unless the library was |br|
explicitly added as a static library.
- Builds internal libraries as shared libraries, i.e. cause :func:`add_library` CMake |br|
function to create shared libraries if on. All libraries are built shared unless the |br|
library was explicitly added as a static library.
- ``ON`` ``OFF``
- ``ON``
* - :class:`SECURITY`
- Activates the *Fast DDS* security module. Please refer to :ref:`security` for more information |br|
on security module.
- Activates the *Fast DDS* security module. Please refer to :ref:`security` for more |br|
information on security module.
- ``ON`` ``OFF``
- ``OFF``
* - :class:`NO_TLS`
- Disables Transport Layer Security (TLS) Support. Please refer to :ref:`transport_tcp_tls` for |br|
more information on *Fast DDS* TLS configuration.
- Disables Transport Layer Security (TLS) Support. Please refer to :ref:`transport_tcp_tls` |br|
for more information on *Fast DDS* TLS configuration.
- ``ON`` ``OFF``
- ``OFF``
* - :class:`SHM_TRANSPORT_DEFAULT`
- Adds Shared Memory transport (SHM) to the default transports.
Please refer to :ref:`SHM <transport_sharedMemory_sharedMemory>` section |br|
for more information on *Fast DDS* SHM transport.
Please refer to |br|
:ref:`SHM <transport_sharedMemory_sharedMemory>` section for more information on *Fast DDS* SHM transport.
- ``ON`` ``OFF``
- ``ON``
* - :class:`FASTDDS_STATISTICS`
- Enables the *Fast DDS* Statistics module. Please refer to :ref:`statistics` for more |br|
information on this module.
- Enables the *Fast DDS* Statistics module. Please refer to :ref:`statistics` for |br|
more information on this module.
- ``ON`` ``OFF``
- ``OFF``
* - :class:`COMPILE_EXAMPLES`
- Builds the *Fast DDS* examples. It is set to ``ON`` if :class:`EPROSIMA_BUILD` is ``ON`` and |br|
:class:`EPROSIMA_INSTALLER` is ``OFF``. These examples can be found in the
`eProsima Fast DDS <https://github.com/eProsima/Fast-DDS/tree/master/examples>`_ |br|
:class:`EPROSIMA_INSTALLER` is ``OFF``. These examples can be found in the |br|
`eProsima Fast DDS <https://github.com/eProsima/Fast-DDS/tree/master/examples>`_
`GitHub repository <https://github.com/eProsima/Fast-DDS/tree/master/examples>`_.
- ``ON`` ``OFF``
- ``OFF``
Expand All @@ -98,8 +99,8 @@ dependency on other options.
- ``ON`` ``OFF``
- ``OFF``
* - :class:`BUILD_DOCUMENTATION`
- Uses doxygen to create the *Fast DDS* API reference documentation. It is set to ``ON`` |br|
if :class:`EPROSIMA_INSTALLER` is ``ON`` or if :class:`CHECK_DOCUMENTATION` is ``ON``.
- Uses doxygen to create the *Fast DDS* API reference documentation. It is set to |br|
``ON`` if :class:`EPROSIMA_INSTALLER` is ``ON`` or if :class:`CHECK_DOCUMENTATION` is ``ON``.
- ``ON`` ``OFF``
- ``OFF``
* - :class:`CHECK_DOCUMENTATION`
Expand All @@ -120,6 +121,12 @@ dependency on other options.
and therefore the :ref:`persistence_service`.
- ``ON`` ``OFF``
- ``ON``
* - :class:`APPEND_PROJECT_NAME_TO_INCLUDEDIR`
- When ``ON`` headers are installed to a path ending with a folder called ``fastrtps``. |br|
This avoids include directory search order issues when overriding this package |br|
from a merged catkin, ament, or colcon workspace.
- ``ON`` ``OFF``
- ``OFF``

Log options
^^^^^^^^^^^
Expand Down