Skip to content

Commit 590700a

Browse files
authored
Minor RTI Connext DDS documentation improvements (#5606)
* add script to find connext installations and add instruction to install dependencies when building from source Signed-off-by: jncfa <[email protected]> * implemented suggestions from review, added note regarding different shells Signed-off-by: jncfa <[email protected]> --------- Signed-off-by: jncfa <[email protected]>
1 parent 3b33114 commit 590700a

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

source/Installation/RMW-Implementations/DDS-Implementations/Working-with-RTI-Connext-DDS.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,30 @@ Clone the repository for ``rmw_connextdds`` into your ROS 2 workspace and select
7878
$ cd ros2_ws
7979
$ git clone -b {DISTRO} https://github.com/ros2/rmw_connextdds src/rmw_connextdds
8080
81+
Then, install necessary packages for RTI Connext DDS.
82+
83+
.. code-block:: console
84+
85+
$ cd ..
86+
$ rosdep install --from src -i
87+
8188
Set up the environment to help colcon discover where RTI Connext is installed.
82-
This can be done by manually setting the environment variable ``NDDSHOME`` to the location of the RTI Connext installation, or by using a script that comes with the RTI Connext installation:
89+
This can be done by manually setting the environment variable ``NDDSHOME`` to the location of the RTI Connext installation, or by using a script that comes with the RTI Connext installation. For example, for version 7.3.0, you can run the following code to execute the helper script:
90+
91+
.. code-block:: console
92+
93+
$ source /opt/rti.com/rti_connext_dds-7.3.0/resource/scripts/rtisetenv_x64Linux4gcc7.3.0.bash
94+
95+
If the previous command failed, and you can't find the location of the RTI Connext installation, run this to find all Connext installations (and their corresponding helper scripts) in your system:
8396

8497
.. code-block:: console
8598
86-
$ source ${RTI_CONNEXT_INSTALL_LOCATION}/resource/scripts/rtisetenv_x64Linux4gcc7.3.0.bash
99+
$ find /opt -name rtisetenv*.bash
100+
101+
.. note::
102+
103+
Replace ``.bash`` with your shell if you're not using bash.
104+
Possible values are: ``rtisetenv*.bash``, ``rtisetenv*.sh``, ``rtisetenv*.zsh``, ``rtisetenv*.tcsh``.
87105

88106
Make sure you have the ROS 2 environment set up:
89107

0 commit comments

Comments
 (0)