Skip to content

Commit

Permalink
Improve build steps in the installation from sources sections (#812)
Browse files Browse the repository at this point in the history
Signed-off-by: JesusPoderoso <[email protected]>
  • Loading branch information
JesusPoderoso authored Jun 14, 2024
1 parent d53fab7 commit f50c0c0
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 17 deletions.
15 changes: 9 additions & 6 deletions docs/installation/sources/sources_linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The following packages will be installed:

* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
`library <https://github.com/foonathan/memory>`_.
* :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 <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
Expand Down Expand Up @@ -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::

Expand Down Expand Up @@ -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::

Expand Down Expand Up @@ -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
------------
Expand Down Expand Up @@ -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::
Expand Down
13 changes: 8 additions & 5 deletions docs/installation/sources/sources_mac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ sources. The following packages will be installed:

* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
`library <https://github.com/foonathan/memory>`_.
* :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 <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
Expand Down Expand Up @@ -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::

Expand Down Expand Up @@ -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
------------
Expand Down Expand Up @@ -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::
Expand Down
1 change: 1 addition & 0 deletions docs/installation/sources/sources_qnx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ sources. The following packages will be installed:

* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
`library <https://github.com/foonathan/memory>`_.
* :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 <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
Expand Down
15 changes: 9 additions & 6 deletions docs/installation/sources/sources_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The following packages will be installed:

* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
`library <https://github.com/foonathan/memory>`_.
* :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 <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
Expand Down Expand Up @@ -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::

Expand Down Expand Up @@ -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::

Expand Down Expand Up @@ -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
------------
Expand Down Expand Up @@ -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::
Expand Down

0 comments on commit f50c0c0

Please sign in to comment.