From f50c0c03a5920786c3b1acbb619029eff61ed64f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Poderoso?= <120394830+JesusPoderoso@users.noreply.github.com> Date: Fri, 14 Jun 2024 13:31:27 +0200 Subject: [PATCH] Improve build steps in the installation from sources sections (#812) Signed-off-by: JesusPoderoso --- docs/installation/sources/sources_linux.rst | 15 +++++++++------ docs/installation/sources/sources_mac.rst | 13 ++++++++----- docs/installation/sources/sources_qnx.rst | 1 + docs/installation/sources/sources_windows.rst | 15 +++++++++------ 4 files changed, 27 insertions(+), 17 deletions(-) diff --git a/docs/installation/sources/sources_linux.rst b/docs/installation/sources/sources_linux.rst index a61f64930..cc9487e05 100644 --- a/docs/installation/sources/sources_linux.rst +++ b/docs/installation/sources/sources_linux.rst @@ -23,6 +23,7 @@ The following packages will be installed: * :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator `library `_. +* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file. * :code:`fastcdr`, a C++ library that serializes according to the `standard CDR `_ serialization mechanism. * :code:`fastrtps`, the core library of *eProsima Fast DDS* library. @@ -227,7 +228,7 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen .. code-block:: bash - colcon build + colcon build --packages-up-to fastrtps .. note:: @@ -445,7 +446,7 @@ This section explains how to use it to compile *Fast DDS Python bindings* and it .. code-block:: bash - colcon build + colcon build --packages-up-to fastdds_python .. note:: @@ -590,7 +591,8 @@ Fast DDS-Gen installation This section provides the instructions for installing *Fast DDS-Gen* in a Linux environment from sources. *Fast DDS-Gen* is a Java application that generates source code using the data types defined in an IDL file. -Please refer to :ref:`fastddsgen_intro` for more information. +Please refer to :ref:`fastddsgen_intro` for more information, and to +:ref:`dependencies_compatibilities_product_compatibility` for the compatibility matrix against Fast DDS versions. Requirements ------------ @@ -645,9 +647,10 @@ Please, follow the steps below to build *Fast DDS-Gen*: .. code-block:: bash - cd ~ - git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git - cd Fast-DDS-Gen + mkdir -p ~/Fast-DDS/src + cd ~/Fast-DDS/src + git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git fastddsgen + cd fastddsgen ./gradlew assemble .. note:: diff --git a/docs/installation/sources/sources_mac.rst b/docs/installation/sources/sources_mac.rst index 5338ca2d6..fd5f309c2 100644 --- a/docs/installation/sources/sources_mac.rst +++ b/docs/installation/sources/sources_mac.rst @@ -22,6 +22,7 @@ sources. The following packages will be installed: * :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator `library `_. +* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file. * :code:`fastcdr`, a C++ library that serializes according to the `standard CDR `_ serialization mechanism. * :code:`fastrtps`, the core library of *eProsima Fast DDS* library. @@ -181,7 +182,7 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen .. code-block:: bash - colcon build + colcon build --packages-up-to fastrtps .. note:: @@ -323,7 +324,8 @@ Fast DDS-Gen installation This section provides the instructions for installing *Fast DDS-Gen* in a Mac OS environment from sources. *Fast DDS-Gen* is a Java application that generates source code using the data types defined in an IDL file. -Please refer to :ref:`fastddsgen_intro` for more information. +Please refer to :ref:`fastddsgen_intro` for more information, and to +:ref:`dependencies_compatibilities_product_compatibility` for the compatibility matrix against Fast DDS versions. Requirements ------------ @@ -374,9 +376,10 @@ Please, follow the steps below to build *Fast DDS-Gen*: .. code-block:: bash - cd ~ - git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git - cd Fast-DDS-Gen + mkdir -p ~/Fast-DDS/src + cd ~/Fast-DDS/src + git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git fastddsgen + cd fastddsgen ./gradlew assemble .. note:: diff --git a/docs/installation/sources/sources_qnx.rst b/docs/installation/sources/sources_qnx.rst index 7c34b2b1f..122103159 100644 --- a/docs/installation/sources/sources_qnx.rst +++ b/docs/installation/sources/sources_qnx.rst @@ -22,6 +22,7 @@ sources. The following packages will be installed: * :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator `library `_. +* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file. * :code:`fastcdr`, a C++ library that serializes according to the `standard CDR `_ serialization mechanism. * :code:`fastrtps`, the core library of *eProsima Fast DDS* library. diff --git a/docs/installation/sources/sources_windows.rst b/docs/installation/sources/sources_windows.rst index f5fd8c2ce..265e55996 100644 --- a/docs/installation/sources/sources_windows.rst +++ b/docs/installation/sources/sources_windows.rst @@ -22,6 +22,7 @@ The following packages will be installed: * :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator `library `_. +* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file. * :code:`fastcdr`, a C++ library that serializes according to the `standard CDR `_ serialization mechanism. * :code:`fastrtps`, the core library of *eProsima Fast DDS* library. @@ -277,7 +278,7 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen .. code-block:: bash - colcon build + colcon build --packages-up-to fastrtps .. note:: @@ -474,7 +475,7 @@ This section explains how to use it to compile *Fast DDS Python bindings* and it .. code-block:: bash - colcon build + colcon build --packages-up-to fastdds_python .. note:: @@ -612,7 +613,8 @@ Fast DDS-Gen installation This section outlines the instructions for installing *Fast DDS-Gen* in a Windows environment from sources. *Fast DDS-Gen* is a Java application that generates source code using the data types defined in an IDL file. -Please refer to :ref:`fastddsgen_intro` for more information. +Please refer to :ref:`fastddsgen_intro` for more information, and to +:ref:`dependencies_compatibilities_product_compatibility` for the compatibility matrix against Fast DDS versions. Requirements ------------ @@ -663,9 +665,10 @@ Please, follow the steps below to build *Fast DDS-Gen*: .. code-block:: bash - cd ~ - git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git - cd Fast-DDS-Gen + mkdir -p ~/Fast-DDS/src + cd ~/Fast-DDS/src + git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git fastddsgen + cd fastddsgen gradlew.bat assemble .. note::