Skip to content

Commit

Permalink
Clarify Linux installation from sources (#325)
Browse files Browse the repository at this point in the history
* Refs #13767: Fix documentation issue

Signed-off-by: Victor Maroto <victormaroto@eprosima.com>
Signed-off-by: Victor M Maroto <victormaroto@eprosima.com>

* Refs #13767: Apply suggestions

Signed-off-by: Eduardo Ponz <eduardoponz@eprosima.com>

* Refs #13767: Update pip3 installation directory note

Signed-off-by: Eduardo Ponz <eduardoponz@eprosima.com>

Co-authored-by: Eduardo Ponz <eduardoponz@eprosima.com>
  • Loading branch information
VictorMMaroto and EduPonz authored Jun 8, 2022
1 parent 3d9d45c commit f078c3d
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions docs/installation/sources/sources_linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,10 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen
.. note::

If this fails due to an Environment Error, add the :code:`--user` flag to the :code:`pip3` installation command.
Mind that under non-root users, :code:`pip3` may install python :code:`colcon` and :code:`vcs` executables in
:code:`$HOME/.local/bin`, for instance when running with :code:`--user`.
To be able to run these applications, make sure that :code:`pip3` binary installation directory is in your
:code:`$PATH` (:code:`$HOME/.local/bin` is normally introduced while login on an interactive non-root shell).

#. Create a :code:`Fast-DDS` directory and download the repos file that will be used to install
*eProsima Fast DDS* and its dependencies:
Expand Down Expand Up @@ -578,8 +581,11 @@ Java JDK
^^^^^^^^

The JDK is a development environment for building applications and components using the Java language.
Download and install it at the following the steps given in the
`Oracle website <https://www.oracle.com/java/technologies/javase-downloads.html>`_.
To install Java JDK, run:

.. code-block:: bash
sudo apt install openjdk-8-jdk
.. _gradle_sl:

Expand All @@ -594,18 +600,18 @@ Compiling Fast DDS-Gen

Once the requirements above are met, compile *Fast DDS-Gen* by following the steps below:

.. note::

If Fast DDS has already been installed following :ref:`colcon_installation_linux`, skip cloning *Fast DDS-Gen*'s
repository, as it can be already be found under the :code:`src` directory within the colcon workspace.

.. code-block:: bash
cd ~
git clone --recursive https://github.com/eProsima/Fast-DDS-Gen.git
cd Fast-DDS-Gen
gradle assemble
.. note::

If already installed FastDDS with colcon, you may skip the git clone command; *fastddsgen* can be found under
the :code:`src` directory of FastDDS colcon workspace.

.. note::

If errors occur during compilation or you do not wish to install gradle, an executable script is included which will
Expand Down

0 comments on commit f078c3d

Please sign in to comment.