Skip to content

Commit f50c0c0

Browse files
JesusPoderosoJesusPoderoso
authored
Improve build steps in the installation from sources sections (#812)
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
1 parent d53fab7 commit f50c0c0

4 files changed

Lines changed: 27 additions & 17 deletions

File tree

‎docs/installation/sources/sources_linux.rst‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The following packages will be installed:
2323

2424
* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
2525
`library <https://github.com/foonathan/memory>`_.
26+
* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file.
2627
* :code:`fastcdr`, a C++ library that serializes according to the
2728
`standard CDR <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
2829
* :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
227228

228229
.. code-block:: bash
229230
230-
colcon build
231+
colcon build --packages-up-to fastrtps
231232
232233
.. note::
233234

@@ -445,7 +446,7 @@ This section explains how to use it to compile *Fast DDS Python bindings* and it
445446

446447
.. code-block:: bash
447448
448-
colcon build
449+
colcon build --packages-up-to fastdds_python
449450
450451
.. note::
451452

@@ -590,7 +591,8 @@ Fast DDS-Gen installation
590591
This section provides the instructions for installing *Fast DDS-Gen* in a Linux environment from
591592
sources.
592593
*Fast DDS-Gen* is a Java application that generates source code using the data types defined in an IDL file.
593-
Please refer to :ref:`fastddsgen_intro` for more information.
594+
Please refer to :ref:`fastddsgen_intro` for more information, and to
595+
:ref:`dependencies_compatibilities_product_compatibility` for the compatibility matrix against Fast DDS versions.
594596

595597
Requirements
596598
------------
@@ -645,9 +647,10 @@ Please, follow the steps below to build *Fast DDS-Gen*:
645647

646648
.. code-block:: bash
647649
648-
cd ~
649-
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git
650-
cd Fast-DDS-Gen
650+
mkdir -p ~/Fast-DDS/src
651+
cd ~/Fast-DDS/src
652+
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git fastddsgen
653+
cd fastddsgen
651654
./gradlew assemble
652655
653656
.. note::

‎docs/installation/sources/sources_mac.rst‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ sources. The following packages will be installed:
2222

2323
* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
2424
`library <https://github.com/foonathan/memory>`_.
25+
* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file.
2526
* :code:`fastcdr`, a C++ library that serializes according to the
2627
`standard CDR <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
2728
* :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
181182

182183
.. code-block:: bash
183184
184-
colcon build
185+
colcon build --packages-up-to fastrtps
185186
186187
.. note::
187188

@@ -323,7 +324,8 @@ Fast DDS-Gen installation
323324
This section provides the instructions for installing *Fast DDS-Gen* in a Mac OS environment from
324325
sources.
325326
*Fast DDS-Gen* is a Java application that generates source code using the data types defined in an IDL file.
326-
Please refer to :ref:`fastddsgen_intro` for more information.
327+
Please refer to :ref:`fastddsgen_intro` for more information, and to
328+
:ref:`dependencies_compatibilities_product_compatibility` for the compatibility matrix against Fast DDS versions.
327329

328330
Requirements
329331
------------
@@ -374,9 +376,10 @@ Please, follow the steps below to build *Fast DDS-Gen*:
374376

375377
.. code-block:: bash
376378
377-
cd ~
378-
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git
379-
cd Fast-DDS-Gen
379+
mkdir -p ~/Fast-DDS/src
380+
cd ~/Fast-DDS/src
381+
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git fastddsgen
382+
cd fastddsgen
380383
./gradlew assemble
381384
382385
.. note::

‎docs/installation/sources/sources_qnx.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ sources. The following packages will be installed:
2222

2323
* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
2424
`library <https://github.com/foonathan/memory>`_.
25+
* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file.
2526
* :code:`fastcdr`, a C++ library that serializes according to the
2627
`standard CDR <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
2728
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.

‎docs/installation/sources/sources_windows.rst‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The following packages will be installed:
2222

2323
* :code:`foonathan_memory_vendor`, an STL compatible C++ memory allocator
2424
`library <https://github.com/foonathan/memory>`_.
25+
* :code:`fastdds_gen`, a Java application that generates source code using the data types defined in an IDL file.
2526
* :code:`fastcdr`, a C++ library that serializes according to the
2627
`standard CDR <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
2728
* :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
277278

278279
.. code-block:: bash
279280
280-
colcon build
281+
colcon build --packages-up-to fastrtps
281282
282283
.. note::
283284

@@ -474,7 +475,7 @@ This section explains how to use it to compile *Fast DDS Python bindings* and it
474475

475476
.. code-block:: bash
476477
477-
colcon build
478+
colcon build --packages-up-to fastdds_python
478479
479480
.. note::
480481

@@ -612,7 +613,8 @@ Fast DDS-Gen installation
612613
This section outlines the instructions for installing *Fast DDS-Gen* in a Windows environment from
613614
sources.
614615
*Fast DDS-Gen* is a Java application that generates source code using the data types defined in an IDL file.
615-
Please refer to :ref:`fastddsgen_intro` for more information.
616+
Please refer to :ref:`fastddsgen_intro` for more information, and to
617+
:ref:`dependencies_compatibilities_product_compatibility` for the compatibility matrix against Fast DDS versions.
616618

617619
Requirements
618620
------------
@@ -663,9 +665,10 @@ Please, follow the steps below to build *Fast DDS-Gen*:
663665

664666
.. code-block:: bash
665667
666-
cd ~
667-
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git
668-
cd Fast-DDS-Gen
668+
mkdir -p ~/Fast-DDS/src
669+
cd ~/Fast-DDS/src
670+
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git fastddsgen
671+
cd fastddsgen
669672
gradlew.bat assemble
670673
671674
.. note::

0 commit comments

Comments
 (0)