Skip to content

Commit e698071

Browse files
sloretzclalancette
andauthored
Delete stale reference to default RMW implementation being CycloneDDS (ros2#2346)
* Delete stale reference to default RMW implementation Signed-off-by: Shane Loretz <[email protected]> * Switch more places over to Fast DDS. There were a lot more instances. Signed-off-by: Chris Lalancette <[email protected]> Co-authored-by: Chris Lalancette <[email protected]>
1 parent 9597b9b commit e698071

13 files changed

+28
-29
lines changed

source/Concepts/About-Different-Middleware-Vendors.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ Supported RMW implementations
3333
* - eProsima *Fast DDS*
3434
- Apache 2
3535
- ``rmw_fastrtps_cpp``
36-
- Full support. Default RMW in Foxy and before. Packaged with binary releases.
36+
- Full support. Default RMW. Packaged with binary releases.
3737
* - Eclipse *Cyclone DDS*
3838
- Eclipse Public License v2.0
3939
- ``rmw_cyclonedds_cpp``
40-
- Full support. Default RMW since Galactic. Packaged with binary releases.
40+
- Full support. Packaged with binary releases.
4141
* - RTI *Connext DDS*
4242
- commercial, research
4343
- ``rmw_connextdds``
@@ -53,10 +53,9 @@ Multiple RMW implementations
5353
----------------------------
5454

5555
The ROS 2 binary releases for currently active distros have built-in support for several RMW implementations out of the box (Fast DDS, RTI Connext Pro, Eclipse Cyclone DDS, GurumNetworks GurumDDS).
56-
Since Galactic, the default is Cyclone DDS, which works without any additional installation steps, because we distribute it with our binary packages.
57-
Prior to Galactic, the default was Fast DDS, which works without any additional installation steps.
56+
The default is Fast DDS, which works without any additional installation steps because we distribute it with our binary packages.
5857

59-
Other RMWs like Fast DDS, Connext or GurumDDS can be enabled by :doc:`installing additional packages <../Installation/DDS-Implementations>`, but without having to rebuild anything or replace any existing packages.
58+
Other RMWs like Cyclone DDS, Connext or GurumDDS can be enabled by :doc:`installing additional packages <../Installation/DDS-Implementations>`, but without having to rebuild anything or replace any existing packages.
6059

6160
A ROS 2 workspace that has been built from source may build and install multiple RMW implementations simultaneously.
6261
While the core ROS 2 code is being compiled, any RMW implementation that is found will be built if the relevant DDS/RTPS implementation has been installed properly and the relevant environment variables have been configured.
@@ -73,10 +72,10 @@ Here is a list of inter-vendor communication configurations that are not support
7372
Default RMW implementation
7473
--------------------------
7574

76-
If a ROS 2 workspace has multiple RMW implementations, the default RMW implementation since Galactic is selected as Cyclone DDS if it's available.
77-
If the Cyclone DDS RMW implementation is not installed, the RMW implementation with the first RMW implementation identifier in alphabetical order will be used.
75+
If a ROS 2 workspace has multiple RMW implementations, Fast DDS is selected as the default RMW implementation if it is available.
76+
If the Fast DDS RMW implementation is not installed, the RMW implementation with the first RMW implementation identifier in alphabetical order will be used.
7877
The implementation identifier is the name of the ROS package that provides the RMW implementation, e.g. ``rmw_cyclonedds_cpp``.
79-
For example, if both ``rmw_fastrtps_cpp`` and ``rmw_connextdds`` ROS packages are installed, ``rmw_connextdds`` would be the default.
80-
If ``rmw_cyclonedds_cpp`` is ever installed, it would be the default.
78+
For example, if both ``rmw_cyclonedds_cpp`` and ``rmw_connextdds`` ROS packages are installed, ``rmw_connextdds`` would be the default.
79+
If ``rmw_fastrtps_cpp`` is ever installed, it would be the default.
8180

8281
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` for how to specify which RMW implementation is to be used when running the ROS 2 examples.

source/How-To-Guides/Working-with-multiple-RMW-implementations.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ For example, to run the talker demo using the C++ talker and Python listener wit
6565
Adding RMW implementations to your workspace
6666
--------------------------------------------
6767

68-
Suppose that you have built your ROS 2 workspace with only Cyclone DDS installed and therefore only the Cyclone DDS RMW implementation built.
68+
Suppose that you have built your ROS 2 workspace with only Fast DDS installed and therefore only the Fast DDS RMW implementation built.
6969
The last time your workspace was built, any other RMW implementation packages, ``rmw_connextdds`` for example, were probably unable to find installations of the relevant DDS implementations.
7070
If you then install an additional DDS implementation, Connext for example, you will need to re-trigger the check for a Connext installation that occurs when the Connext RMW implementation is being built.
7171
You can do this by specifying the ``--cmake-force-configure`` flag on your next workspace build, and you should see that the RMW implementation package then gets built for the newly installed DDS implementation.
@@ -106,11 +106,11 @@ and
106106
107107
ros2 node list
108108
109-
it will generate a daemon with a Cyclone DDS implementation:
109+
it will generate a daemon with a Fast DDS implementation:
110110

111111
.. code-block:: bash
112112
113-
21318 22.0 0.6 535896 55044 pts/8 Sl 16:14 0:00 /usr/bin/python3 /opt/ros/{DISTRO}/bin/_ros2_daemon --rmw-implementation rmw_cyclonedds_cpp --ros-domain-id 22
113+
21318 22.0 0.6 535896 55044 pts/8 Sl 16:14 0:00 /usr/bin/python3 /opt/ros/{DISTRO}/bin/_ros2_daemon --rmw-implementation rmw_fastrtps_cpp --ros-domain-id 22
114114
115115
Even if you run the command line tool again with the correct RMW implementation, the daemon's RMW implementation will not change and the ROS 2 command line tools will fail.
116116

source/Installation/RHEL-Development-Setup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Install dependencies using rosdep
9898
Install additional DDS implementations (optional)
9999
-------------------------------------------------
100100

101-
If you would like to use another DDS or RTPS vendor besides the default, Cyclone DDS, you can find instructions :doc:`here <DDS-Implementations>`.
101+
If you would like to use another DDS or RTPS vendor besides the default, you can find instructions :doc:`here <DDS-Implementations>`.
102102

103103
Build the code in the workspace
104104
-------------------------------
@@ -160,7 +160,7 @@ Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your en
160160

161161
Additional RMW implementations (optional)
162162
-----------------------------------------
163-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
163+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
164164
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
165165

166166
Alternate compilers

source/Installation/RHEL-Install-Binary.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Set your rosdistro according to the release you downloaded.
8383
Install additional DDS implementations (optional)
8484
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8585

86-
If you would like to use another DDS or RTPS vendor besides the default, Eclipse Cyclone DDS, you can find instructions :doc:`here <DDS-Implementations>`.
86+
If you would like to use another DDS or RTPS vendor besides the default, you can find instructions :doc:`here <DDS-Implementations>`.
8787

8888
Environment setup
8989
-----------------
@@ -124,7 +124,7 @@ Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your en
124124

125125
Additional RMW implementations (optional)
126126
-----------------------------------------
127-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
127+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
128128
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
129129

130130
Troubleshooting

source/Installation/RHEL-Install-RPMs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your en
110110

111111
Additional RMW implementations (optional)
112112
-----------------------------------------
113-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
113+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
114114
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
115115

116116
Troubleshooting

source/Installation/Ubuntu-Development-Setup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Install dependencies using rosdep
108108
Install additional DDS implementations (optional)
109109
-------------------------------------------------
110110

111-
If you would like to use another DDS or RTPS vendor besides the default, Eclipse Cyclone DDS, you can find instructions :doc:`here <DDS-Implementations>`.
111+
If you would like to use another DDS or RTPS vendor besides the default, you can find instructions :doc:`here <DDS-Implementations>`.
112112

113113
Build the code in the workspace
114114
-------------------------------
@@ -174,7 +174,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the
174174

175175
Additional RMW implementations (optional)
176176
-----------------------------------------
177-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
177+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
178178
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
179179

180180
Alternate compilers

source/Installation/Ubuntu-Install-Binary.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Installing the python3 libraries
8787
Install additional DDS implementations (optional)
8888
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8989

90-
If you would like to use another DDS or RTPS vendor besides the default, Eclipse Cyclone DDS, you can find instructions :doc:`here <DDS-Implementations>`.
90+
If you would like to use another DDS or RTPS vendor besides the default, you can find instructions :doc:`here <DDS-Implementations>`.
9191

9292
Environment setup
9393
-----------------
@@ -132,7 +132,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the
132132

133133
Additional RMW implementations (optional)
134134
-----------------------------------------
135-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
135+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
136136
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
137137

138138
Troubleshooting

source/Installation/Ubuntu-Install-Debians.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the
105105

106106
Additional RMW implementations (optional)
107107
-----------------------------------------
108-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
108+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
109109
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
110110

111111
Troubleshooting

source/Installation/Windows-Development-Setup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Next you can use ``vcs`` to import the repositories listed in the ``ros2.repos``
9191
Install additional DDS implementations (optional)
9292
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9393

94-
If you would like to use another DDS or RTPS vendor besides the default, Eclipse Cyclone DDS, you can find instructions :doc:`here <DDS-Implementations>`.
94+
If you would like to use another DDS or RTPS vendor besides the default, you can find instructions :doc:`here <DDS-Implementations>`.
9595

9696
Build the ROS 2 code
9797
--------------------
@@ -186,7 +186,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the
186186

187187
Additional RMW implementations (optional)
188188
-----------------------------------------
189-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
189+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
190190
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
191191

192192

source/Installation/Windows-Install-Binary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The ROS 1 bridge can connect topics from ROS 1 to ROS 2 and vice-versa. See the
8282

8383
Additional RMW implementations (optional)
8484
-----------------------------------------
85-
The default middleware that ROS 2 uses is ``Cyclone DDS``, but the middleware (RMW) can be replaced at runtime.
85+
The default middleware that ROS 2 uses is ``Fast DDS``, but the middleware (RMW) can be replaced at runtime.
8686
See the :doc:`guide <../How-To-Guides/Working-with-multiple-RMW-implementations>` on how to work with multiple RMWs.
8787

8888
Troubleshooting

0 commit comments

Comments
 (0)