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
…816)

Signed-off-by: JesusPoderoso <[email protected]>
(cherry picked from commit f50c0c0)

Co-authored-by: Jesús Poderoso <[email protected]>
  • Loading branch information
mergify[bot] and JesusPoderoso authored Jun 27, 2024
1 parent 6eed613 commit 40f4548
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 15 deletions.
12 changes: 7 additions & 5 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 @@ -208,7 +209,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 @@ -426,7 +427,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 @@ -613,9 +614,10 @@ Once the requirements above are met, compile *Fast DDS-Gen* by following the ste

.. 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
gradle assemble
.. note::
Expand Down
10 changes: 6 additions & 4 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 @@ -163,7 +164,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 @@ -353,9 +354,10 @@ Once the requirements above are met, compile *Fast DDS-Gen* by following the ste

.. 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
gradle assemble
Contents
Expand Down
14 changes: 8 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 @@ -259,7 +260,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 @@ -456,7 +457,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 @@ -628,10 +629,11 @@ Once the requirements above are met, install *Fast DDS-Gen* by following the ste

.. code-block:: bash
cd ~
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git
cd Fast-DDS-Gen
gradle assemble
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
Contents
^^^^^^^^
Expand Down

0 comments on commit 40f4548

Please sign in to comment.