From ca368c6d372947519a1db87482bd69412311477d Mon Sep 17 00:00:00 2001 From: Alejandro Hernandez Cordero Date: Fri, 14 Nov 2025 09:52:41 +0100 Subject: [PATCH 1/4] Updated REP links Signed-off-by: Alejandro Hernandez Cordero --- source/Concepts/Advanced/About-Build-System.rst | 2 +- source/Glossary.rst | 2 +- source/How-To-Guides/Ament-CMake-Documentation.rst | 2 +- source/How-To-Guides/Installing-on-Raspberry-Pi.rst | 6 +++--- .../Migrating-CPP-Package-Example.rst | 2 +- .../Migrating-from-ROS1/Migrating-CPP-Packages.rst | 4 ++-- .../Migrating-from-ROS1/Migrating-Package-XML.rst | 4 ++-- source/How-To-Guides/Releasing/Index-Your-Packages.rst | 4 ++-- .../Releasing/Release-Team-Repository.rst | 2 +- source/How-To-Guides/Releasing/Releasing-a-Package.rst | 2 +- source/How-To-Guides/Using-Variants.rst | 4 ++-- .../How-To-Guides/Using-ros1_bridge-Jammy-upstream.rst | 2 +- .../Working-with-multiple-RMW-implementations.rst | 2 +- source/Installation.rst | 2 +- .../Alternatives/RHEL-Development-Setup.rst | 2 +- .../Installation/Alternatives/RHEL-Install-Binary.rst | 2 +- .../Alternatives/Ubuntu-Development-Setup.rst | 2 +- .../Alternatives/Ubuntu-Install-Binary.rst | 2 +- source/Installation/RHEL-Install-RPMs.rst | 2 +- source/Installation/RMW-Implementations.rst | 2 +- source/Installation/Ubuntu-Install-Debs.rst | 2 +- source/Installation/Windows-Install-Binary.rst | 2 +- source/Releases.rst | 2 +- source/Releases/Release-Ardent-Apalone.rst | 2 +- source/Releases/Release-Bouncy-Bolson.rst | 2 +- source/Releases/Release-Crystal-Clemmys.rst | 2 +- source/Releases/Release-Dashing-Diademata.rst | 2 +- source/Releases/Release-Eloquent-Elusor.rst | 2 +- source/Releases/Release-Foxy-Fitzroy.rst | 2 +- source/Releases/Release-Galactic-Geochelone.rst | 10 +++++----- source/Releases/Release-Humble-Hawksbill.rst | 8 ++++---- source/Releases/Release-Iron-Irwini.rst | 6 +++--- source/Releases/Release-Jazzy-Jalisco.rst | 10 +++++----- source/Releases/Release-Kilted-Kaiju.rst | 10 +++++----- source/Releases/Release-Lyrical-Luth.rst | 2 +- source/Releases/Release-Process.rst | 2 +- source/Releases/Release-Rolling-Ridley.rst | 2 +- .../Advanced/Creating-An-RMW-Implementation.rst | 2 +- source/Tutorials/Advanced/Simulators/Gazebo/Gazebo.rst | 2 +- .../Beginner-Client-Libraries/Colcon-Tutorial.rst | 2 +- source/Tutorials/Intermediate/Rosdep.rst | 2 +- source/index.rst | 4 ++-- 42 files changed, 66 insertions(+), 66 deletions(-) diff --git a/source/Concepts/Advanced/About-Build-System.rst b/source/Concepts/Advanced/About-Build-System.rst index 9c68a7f2eee..f72b1a67659 100644 --- a/source/Concepts/Advanced/About-Build-System.rst +++ b/source/Concepts/Advanced/About-Build-System.rst @@ -46,7 +46,7 @@ Parsing of the :term:`package.xml` files is provided by ``catkin_pkg`` (as in RO package.xml Package manifest file which marks the root of a :term:`package` and contains meta information about the :term:`package` including its name, version, description, maintainer, license, dependencies, and more. - The contents of the manifest are in machine readable XML format and the contents are described in the |REPs| `127 `_ and `140 `_, with the possibility of further modifications in future |REPs|. + The contents of the manifest are in machine readable XML format and the contents are described in the |REPs| `127 `_ and `140 `_, with the possibility of further modifications in future |REPs|. So anytime some |package| is referred to as an :term:`ament package`, it means that it is a single unit of software (source code, build files, tests, documentation, and other resources) which is described using a :term:`package.xml` manifest file. diff --git a/source/Glossary.rst b/source/Glossary.rst index baa17e420ad..c6ad5ab8237 100644 --- a/source/Glossary.rst +++ b/source/Glossary.rst @@ -24,7 +24,7 @@ Glossary of terms used throughout this documentation: ROS Enhancement Proposal. A document that describes an enhancement, standardization, or convention for the ROS community. The associated REP approval process allows the community to iterate on a proposal until some consensus has been made, at which point it can be ratified and implemented, which then becomes documentation. - All REPs are viewable from the `REP index `_. + All REPs are viewable from the `REP index `_. VCS Version Control System, such as CVS, SVN, git, mercurial, etc... diff --git a/source/How-To-Guides/Ament-CMake-Documentation.rst b/source/How-To-Guides/Ament-CMake-Documentation.rst index 23e1ab8191c..c1daca1ec5e 100644 --- a/source/How-To-Guides/Ament-CMake-Documentation.rst +++ b/source/How-To-Guides/Ament-CMake-Documentation.rst @@ -65,7 +65,7 @@ Compiler and linker options ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ROS 2 targets compilers which comply with the C++17 and C99 standard. -Newer versions might be targeted in the future and are referenced `here `__. +Newer versions might be targeted in the future and are referenced `here `__. Therefore it is customary to set the corresponding CMake flags: .. code-block:: cmake diff --git a/source/How-To-Guides/Installing-on-Raspberry-Pi.rst b/source/How-To-Guides/Installing-on-Raspberry-Pi.rst index e6df245f2e1..d462fddc87f 100644 --- a/source/How-To-Guides/Installing-on-Raspberry-Pi.rst +++ b/source/How-To-Guides/Installing-on-Raspberry-Pi.rst @@ -2,7 +2,7 @@ ROS 2 on Raspberry Pi ===================== ROS 2 is supported on both 32 bit (arm32) and 64 bit (arm64) ARM processors. -However, you can see `here `__ that arm64 receives Tier 1 support, while arm32 is Tier 3. +However, you can see `here `__ that arm64 receives Tier 1 support, while arm32 is Tier 3. Tier 1 support means distribution specific packages and binary archives are available, while Tier 3 requires the user to compile ROS 2 from source. The fastest and simplest way to use ROS 2 is to use a Tier 1 supported configuration. @@ -14,7 +14,7 @@ Ubuntu Linux on Raspberry Pi with binary ROS 2 install Ubuntu for Raspberry Pi is available `here `__. -Make sure to confirm that you have selected the correct version as described in `REP-2000 `__. +Make sure to confirm that you have selected the correct version as described in `REP-2000 `__. You can now install ROS 2 using the normal binary installation instructions for Ubuntu Linux. @@ -30,7 +30,7 @@ After flashing the OS, `install Docker `__. You may choose from ros-core, ros-base, or perception. -See `here `__ for more information on these variants. +See `here `__ for more information on these variants. Fetch and run an image: diff --git a/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Package-Example.rst b/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Package-Example.rst index ab29f167461..534174aaf5c 100644 --- a/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Package-Example.rst +++ b/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Package-Example.rst @@ -328,7 +328,7 @@ Require a newer version of CMake so that ``ament_cmake`` functions work correctl cmake_minimum_required(VERSION 3.14.4) -Use a newer C++ standard matching the version used by your target ROS distro in `REP 2000 `__. +Use a newer C++ standard matching the version used by your target ROS distro in `REP 2000 `__. If you are using C++17, then set that version with the following snippet after the ``project(talker)`` call. Add extra compiler checks too because it is a good practice. diff --git a/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst b/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst index ac6b5655a18..1c74d86d1c3 100644 --- a/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst +++ b/source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst @@ -32,8 +32,8 @@ Require a newer version of CMake ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ROS 2 relies on newer versions of CMake than used by ROS 1. -Find the minimum version of CMake used by the ROS distribution you want to support in `REP 2000 `__, and use that version at the top of your ``CMakeLists.txt``. -For example, `3.14.4 is the minimum recommended support for ROS Humble `__. +Find the minimum version of CMake used by the ROS distribution you want to support in `REP 2000 `__, and use that version at the top of your ``CMakeLists.txt``. +For example, `3.14.4 is the minimum recommended support for ROS Humble `__. .. code-block:: diff --git a/source/How-To-Guides/Migrating-from-ROS1/Migrating-Package-XML.rst b/source/How-To-Guides/Migrating-from-ROS1/Migrating-Package-XML.rst index b2838744d06..1e9a8861a59 100644 --- a/source/How-To-Guides/Migrating-from-ROS1/Migrating-Package-XML.rst +++ b/source/How-To-Guides/Migrating-from-ROS1/Migrating-Package-XML.rst @@ -5,7 +5,7 @@ Migrating your package.xml to format 2 :depth: 2 :local: -ROS 2 requires ``package.xml`` files to use at least `format 2 `__. +ROS 2 requires ``package.xml`` files to use at least `format 2 `__. This guide shows how to migrate a ``package.xml`` from format 1 to format 2. If the ```` tag at the start of your ``package.xml`` looks like either of the following, then it is using format 1 and you must migrate it. @@ -29,7 +29,7 @@ Migrate from format 1 to 2 -------------------------- Format 1 and format 2 differ in how they specify dependencies. -Read the `compatibility section in REP-0140 `__ for a summary of the differences. +Read the `compatibility section in REP-0140 `__ for a summary of the differences. Add ``format`` attribute to ```` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/How-To-Guides/Releasing/Index-Your-Packages.rst b/source/How-To-Guides/Releasing/Index-Your-Packages.rst index b5dd3d5f1db..296ea168307 100644 --- a/source/How-To-Guides/Releasing/Index-Your-Packages.rst +++ b/source/How-To-Guides/Releasing/Index-Your-Packages.rst @@ -28,7 +28,7 @@ If the ROS packages in your repository have different licenses, create a ``LICEN Give your packages REP 144 compliant names ------------------------------------------ -Packages released into a ROS distribution must have names that comply with `REP 144 `__. +Packages released into a ROS distribution must have names that comply with `REP 144 `__. Read the full REP to understand the rules. If one of your ROS package names doesn't comply, then change the name before continuing. @@ -79,7 +79,7 @@ Here's how to fill out each item: * YOUR-BRANCH-NAME: This is the git branch on your repository from which you will release your package into this ROS distribution. This is commonly one of: ``main``, ``master``, or the name of the ROS distribution itself. For example, the `rosidl repository `__ uses the branch ``rolling`` to hold changes to be released into ROS Rolling. -* YOUR-STATUS: This is a status from the list in `REP 141 `__. +* YOUR-STATUS: This is a status from the list in `REP 141 `__. You likely want either ``maintained`` or ``developed``. Open a pull request to ros/rosdistro diff --git a/source/How-To-Guides/Releasing/Release-Team-Repository.rst b/source/How-To-Guides/Releasing/Release-Team-Repository.rst index bc0dd92c211..60013cecf52 100644 --- a/source/How-To-Guides/Releasing/Release-Team-Repository.rst +++ b/source/How-To-Guides/Releasing/Release-Team-Repository.rst @@ -61,7 +61,7 @@ Create a new release repository ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If your repository is new to the ROS community, you should first open a pull request on `ros/rosdistro `_ adding a ``source`` entry for your repository (e.g. https://github.com/ros/rosdistro/pull/39513). -The review process for the rosdistro database will ensure your repository and packages conform to the `REP 144 package naming conventions `_ and other requirements before release. +The review process for the rosdistro database will ensure your repository and packages conform to the `REP 144 package naming conventions `_ and other requirements before release. Once your package name has been approved and merged, fill in the `Add New Release Repositories issue `_ issue template if you don't have a release repo for your project yet. diff --git a/source/How-To-Guides/Releasing/Releasing-a-Package.rst b/source/How-To-Guides/Releasing/Releasing-a-Package.rst index 47527471db0..b005b0a979e 100644 --- a/source/How-To-Guides/Releasing/Releasing-a-Package.rst +++ b/source/How-To-Guides/Releasing/Releasing-a-Package.rst @@ -20,7 +20,7 @@ Releasing a Package **Releasing a package makes your package available on the public ROS 2 buildfarm.** This will: -* Make your package available to be installed via package managers (e.g. ``apt`` on Ubuntu) for all supported Linux platforms in a ROS distribution as described in `REP 2000 `_. +* Make your package available to be installed via package managers (e.g. ``apt`` on Ubuntu) for all supported Linux platforms in a ROS distribution as described in `REP 2000 `_. * Allow your package to have API documentation automatically generated. * Make your package part of the `ROS Index `_. * (Optionally) Allow you to have automatic CI run for pull requests in your repository. diff --git a/source/How-To-Guides/Using-Variants.rst b/source/How-To-Guides/Using-Variants.rst index aec370ac641..4f0de7bd56e 100644 --- a/source/How-To-Guides/Using-Variants.rst +++ b/source/How-To-Guides/Using-Variants.rst @@ -8,9 +8,9 @@ Variants are a list of official metapackages for commonly useful groups of ROS p .. [#] https://wiki.debian.org/metapackage .. [#] https://help.ubuntu.com/community/MetaPackages -The different variants in ROS 2 are specified in `REP-2001 `_. +The different variants in ROS 2 are specified in `REP-2001 `_. -In addition to the official variants, there may be metapackages for specific institutions or robots as described in `REP-108 `_. +In addition to the official variants, there may be metapackages for specific institutions or robots as described in `REP-108 `_. Adding variants --------------- diff --git a/source/How-To-Guides/Using-ros1_bridge-Jammy-upstream.rst b/source/How-To-Guides/Using-ros1_bridge-Jammy-upstream.rst index 8f468ac87c8..86a9cba5458 100644 --- a/source/How-To-Guides/Using-ros1_bridge-Jammy-upstream.rst +++ b/source/How-To-Guides/Using-ros1_bridge-Jammy-upstream.rst @@ -6,7 +6,7 @@ Using ``ros1_bridge`` with upstream ROS on Ubuntu 22.04 :local: The release of ROS 2 Humble (and Rolling) on Ubuntu 22.04 Jammy Jellyfish marks the first ROS 2 release on a platform with no official ROS 1 release. -While ROS 1 Noetic will continue to be supported through the duration of its `long term support window `__, it will only target Ubuntu 20.04. +While ROS 1 Noetic will continue to be supported through the duration of its `long term support window `__, it will only target Ubuntu 20.04. Alternatively, there are `upstream variants of ROS 1 packages `__ in Debian and Ubuntu that are not maintained as an official distribution by the ROS maintainers. This guide outlines the current mechanism for bridging ROS 2 releases with these upstream packages on Ubuntu 22.04 Jammy Jellyfish. diff --git a/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst b/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst index 492c1dbc88b..1dd73e6ed16 100644 --- a/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst +++ b/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst @@ -103,7 +103,7 @@ To check the RMW that is currently in use you simply check the ``RMW_IMPLEMENTAT On Linux systems ``printenv`` prints the full list of environment variables. Other operating systems will have other procedures for viewing environment variables. If ``RMW_IMPLEMENTATION`` is not in the environment it is safe to assume you are using the default for your ROS distro, otherwise the current RMW is the value listed. -The default RMW for each ROS Distro can be found in `REP-2000 `_. +The default RMW for each ROS Distro can be found in `REP-2000 `_. Ensuring use of a particular RMW implementation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/source/Installation.rst b/source/Installation.rst index 62c46fcb962..1bbe61975db 100644 --- a/source/Installation.rst +++ b/source/Installation.rst @@ -23,7 +23,7 @@ Options for installing ROS 2 {DISTRO_TITLE_FULL}: Binary packages --------------- -Binaries are only created for the Tier 1 operating systems listed in `REP-2000 `__. +Binaries are only created for the Tier 1 operating systems listed in `REP-2000 `__. Given the nature of Rolling, this list may be updated at any time. If you are not running any of the following operating systems you may need to build from source or use a :doc:`container solution ` to run ROS 2 on your platform. diff --git a/source/Installation/Alternatives/RHEL-Development-Setup.rst b/source/Installation/Alternatives/RHEL-Development-Setup.rst index 618e9e1cd35..b47c8595990 100644 --- a/source/Installation/Alternatives/RHEL-Development-Setup.rst +++ b/source/Installation/Alternatives/RHEL-Development-Setup.rst @@ -18,7 +18,7 @@ The current target Red Hat platforms for {DISTRO_TITLE_FULL} are: - Tier 2: RHEL 9 64-bit -As defined in `REP 2000 `_. +As defined in `REP 2000 `_. System setup ------------ diff --git a/source/Installation/Alternatives/RHEL-Install-Binary.rst b/source/Installation/Alternatives/RHEL-Install-Binary.rst index 600ac64b1dd..bfde2329ad3 100644 --- a/source/Installation/Alternatives/RHEL-Install-Binary.rst +++ b/source/Installation/Alternatives/RHEL-Install-Binary.rst @@ -10,7 +10,7 @@ This page explains how to install ROS 2 on RHEL from a pre-built binary package. .. note:: The pre-built binary does not include all ROS 2 packages. - All packages in the `ROS base variant `_ are included, and only a subset of packages in the `ROS desktop variant `_ are included. + All packages in the `ROS base variant `_ are included, and only a subset of packages in the `ROS desktop variant `_ are included. The exact list of packages are described by the repositories listed in `this ros2.repos file `_. There are also :doc:`RPM packages <../RHEL-Install-RPMs>` available. diff --git a/source/Installation/Alternatives/Ubuntu-Development-Setup.rst b/source/Installation/Alternatives/Ubuntu-Development-Setup.rst index 9c3326c507a..179f7635b6e 100644 --- a/source/Installation/Alternatives/Ubuntu-Development-Setup.rst +++ b/source/Installation/Alternatives/Ubuntu-Development-Setup.rst @@ -18,7 +18,7 @@ The current Debian-based target platforms for {DISTRO_TITLE_FULL} are: - Tier 1: Ubuntu Linux - Noble (24.04) 64-bit - Tier 3: Debian Linux - Bookworm (12) 64-bit -As defined in `REP 2000 `_. +As defined in `REP 2000 `_. System setup ------------ diff --git a/source/Installation/Alternatives/Ubuntu-Install-Binary.rst b/source/Installation/Alternatives/Ubuntu-Install-Binary.rst index 41b349bccb6..90ca4862500 100644 --- a/source/Installation/Alternatives/Ubuntu-Install-Binary.rst +++ b/source/Installation/Alternatives/Ubuntu-Install-Binary.rst @@ -14,7 +14,7 @@ This page explains how to install ROS 2 on Ubuntu Linux from a pre-built binary .. note:: The pre-built binary does not include all ROS 2 packages. - All packages in the `ROS base variant `_ are included, and only a subset of packages in the `ROS desktop variant `_ are included. + All packages in the `ROS base variant `_ are included, and only a subset of packages in the `ROS desktop variant `_ are included. The exact list of packages are described by the repositories listed in `this ros2.repos file `_. There are also :doc:`deb packages <../Ubuntu-Install-Debs>` available. diff --git a/source/Installation/RHEL-Install-RPMs.rst b/source/Installation/RHEL-Install-RPMs.rst index 68e2b2bc6d6..ca01b9e038d 100644 --- a/source/Installation/RHEL-Install-RPMs.rst +++ b/source/Installation/RHEL-Install-RPMs.rst @@ -7,7 +7,7 @@ RHEL (RPM packages) RPM packages for ROS 2 {DISTRO_TITLE_FULL} are currently available for RHEL 9. The Rolling Ridley distribution will change target platforms from time to time as new platforms are selected for development. -The target platforms are defined in `REP 2000 `__. +The target platforms are defined in `REP 2000 `__. Most people will want to use a stable ROS distribution. Resources diff --git a/source/Installation/RMW-Implementations.rst b/source/Installation/RMW-Implementations.rst index 9b3242f4007..bb225eed256 100644 --- a/source/Installation/RMW-Implementations.rst +++ b/source/Installation/RMW-Implementations.rst @@ -11,7 +11,7 @@ There is currently support for eProsima's Fast DDS, RTI's Connext DDS, Eclipse C It also supports non DDS RMW implementations such as Zenoh. -See `REP-2000 `__ for supported RMW vendors by distribution. +See `REP-2000 `__ for supported RMW vendors by distribution. The default RMW vendor is eProsima's Fast DDS. diff --git a/source/Installation/Ubuntu-Install-Debs.rst b/source/Installation/Ubuntu-Install-Debs.rst index f69a2ebe07f..edb9b6592d3 100644 --- a/source/Installation/Ubuntu-Install-Debs.rst +++ b/source/Installation/Ubuntu-Install-Debs.rst @@ -12,7 +12,7 @@ Ubuntu (deb packages) Deb packages for ROS 2 {DISTRO_TITLE_FULL} are currently available for Ubuntu Noble (24.04). The Rolling Ridley distribution will change target platforms from time to time as new platforms are selected for development. -The target platforms are defined in `REP 2000 `__. +The target platforms are defined in `REP 2000 `__. Most people will want to use a stable ROS distribution. Resources diff --git a/source/Installation/Windows-Install-Binary.rst b/source/Installation/Windows-Install-Binary.rst index 46ef47f2ce8..2dd301fe8e0 100644 --- a/source/Installation/Windows-Install-Binary.rst +++ b/source/Installation/Windows-Install-Binary.rst @@ -10,7 +10,7 @@ This page explains how to install ROS 2 on Windows from a pre-built binary packa .. note:: The pre-built binary does not include all ROS 2 packages. - All packages in the `ROS base variant `_ are included, and only a subset of packages in the `ROS desktop variant `_ are included. + All packages in the `ROS base variant `_ are included, and only a subset of packages in the `ROS desktop variant `_ are included. The exact list of packages are described by the repositories listed in `this ros2.repos file `_. System requirements diff --git a/source/Releases.rst b/source/Releases.rst index 9a56161346a..960de6b9561 100644 --- a/source/Releases.rst +++ b/source/Releases.rst @@ -202,7 +202,7 @@ Rolling Distribution -------------------- :doc:`ROS 2 Rolling Ridley ` is the rolling development distribution of ROS 2. -It is described in `REP 2002 `_ and was first introduced in June 2020. +It is described in `REP 2002 `_ and was first introduced in June 2020. The Rolling distribution of ROS 2 serves two purposes: diff --git a/source/Releases/Release-Ardent-Apalone.rst b/source/Releases/Release-Ardent-Apalone.rst index eea5404493e..76440779ef8 100644 --- a/source/Releases/Release-Ardent-Apalone.rst +++ b/source/Releases/Release-Ardent-Apalone.rst @@ -71,7 +71,7 @@ Improvements since the Beta 3 release: * Logging API improvements, now also used in the demos * Time support in C++ with different clocks * wait-for-service support in the Python client library -* Draft implementation of `REP 149 `__ specifying format 3 of the package manifest files +* Draft implementation of `REP 149 `__ specifying format 3 of the package manifest files Known Issues ------------ diff --git a/source/Releases/Release-Bouncy-Bolson.rst b/source/Releases/Release-Bouncy-Bolson.rst index c7c63a10765..958651e6c3e 100644 --- a/source/Releases/Release-Bouncy-Bolson.rst +++ b/source/Releases/Release-Bouncy-Bolson.rst @@ -14,7 +14,7 @@ Bouncy Bolson (``bouncy``) Supported Platforms ------------------- -This version of ROS 2 is supported on four platforms (see `REP 2000 `__ for full details): +This version of ROS 2 is supported on four platforms (see `REP 2000 `__ for full details): * Ubuntu 18.04 (Bionic) diff --git a/source/Releases/Release-Crystal-Clemmys.rst b/source/Releases/Release-Crystal-Clemmys.rst index 16ff7f3ebbb..4e128204cef 100644 --- a/source/Releases/Release-Crystal-Clemmys.rst +++ b/source/Releases/Release-Crystal-Clemmys.rst @@ -14,7 +14,7 @@ Crystal Clemmys (``crystal``) Supported Platforms ------------------- -Crystal Clemmys is primarily supported on the following platforms (see `REP 2000 `__ for full details): +Crystal Clemmys is primarily supported on the following platforms (see `REP 2000 `__ for full details): Tier 1 platforms: diff --git a/source/Releases/Release-Dashing-Diademata.rst b/source/Releases/Release-Dashing-Diademata.rst index 9a26bb7699e..eecfc01fa3d 100644 --- a/source/Releases/Release-Dashing-Diademata.rst +++ b/source/Releases/Release-Dashing-Diademata.rst @@ -27,7 +27,7 @@ Tier 3 platforms: * Debian Stretch (9): ``amd64``, ``arm64`` and ``arm32`` * OpenEmbedded Thud (2.6) / webOS OSE: ``arm32`` and ``x86`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ diff --git a/source/Releases/Release-Eloquent-Elusor.rst b/source/Releases/Release-Eloquent-Elusor.rst index 1abe2e41024..fc3e6cacc58 100644 --- a/source/Releases/Release-Eloquent-Elusor.rst +++ b/source/Releases/Release-Eloquent-Elusor.rst @@ -27,7 +27,7 @@ Tier 3 platforms: * Debian Stretch (9): ``amd64``, ``arm64`` and ``arm32`` * OpenEmbedded Thud (2.6) / webOS OSE: ``arm32`` and ``x86`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ diff --git a/source/Releases/Release-Foxy-Fitzroy.rst b/source/Releases/Release-Foxy-Fitzroy.rst index 98cd072972d..9c2bb22dbfd 100644 --- a/source/Releases/Release-Foxy-Fitzroy.rst +++ b/source/Releases/Release-Foxy-Fitzroy.rst @@ -24,7 +24,7 @@ Tier 3 platforms: * Debian Buster (10): ``amd64``, ``arm64`` and ``arm32`` * OpenEmbedded Thud (2.6) / webOS OSE: ``arm32`` and ``x86`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ diff --git a/source/Releases/Release-Galactic-Geochelone.rst b/source/Releases/Release-Galactic-Geochelone.rst index a022f5e5205..aedd3d15eba 100644 --- a/source/Releases/Release-Galactic-Geochelone.rst +++ b/source/Releases/Release-Galactic-Geochelone.rst @@ -37,7 +37,7 @@ Tier 3 platforms: * OpenEmbedded Thud (2.6) / webOS OSE: ``arm32`` and ``arm64`` * Mac macOS 10.14 (Mojave): ``amd64`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ @@ -540,8 +540,8 @@ Large improvements in testing and overall quality ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Galactic contains many changes that fix race conditions, plug memory leaks, and fix user reported problems. -Besides these changes, there was a concerted effort during Galactic development to improve overall quality of the system by implementing `REP 2004 `__. -The ``rclcpp`` package and all of its dependencies (which include most of the ROS 2 non-Python core packages) were brought up to `Quality Level 1 `__ by: +Besides these changes, there was a concerted effort during Galactic development to improve overall quality of the system by implementing `REP 2004 `__. +The ``rclcpp`` package and all of its dependencies (which include most of the ROS 2 non-Python core packages) were brought up to `Quality Level 1 `__ by: * Having a version policy (QL1 requirement 1) * Having a documented change control process (QL1 requirement 2) @@ -993,5 +993,5 @@ Timeline before the release Release announcement. ``rosdistro`` is reopened for Galactic PRs. -.. [1] The ``ros_core`` variant is described in `REP 2001 (ros-core) `_. -.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. +.. [1] The ``ros_core`` variant is described in `REP 2001 (ros-core) `_. +.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. diff --git a/source/Releases/Release-Humble-Hawksbill.rst b/source/Releases/Release-Humble-Hawksbill.rst index 42aa9ba44c3..3c73e85d89c 100644 --- a/source/Releases/Release-Humble-Hawksbill.rst +++ b/source/Releases/Release-Humble-Hawksbill.rst @@ -36,7 +36,7 @@ Tier 3 platforms: * macOS: ``amd64`` * Debian Bullseye: ``amd64`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ @@ -627,7 +627,7 @@ And an example of how the type adapter can be used: [](const std::string & msg) {...}); To learn more, see the `publisher `_ and `subscription `_ examples, as well as a more complex `demo `_. -For more details, see `REP 2007 `_. +For more details, see `REP 2007 `_. ``Client::asnyc_send_request(request)`` returns a ``std::future`` instead of a ``std::shared_future`` """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" @@ -996,5 +996,5 @@ Release Timeline Release announcement. ``rosdistro`` is reopened for Humble PRs. -.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. -.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. +.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. +.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. diff --git a/source/Releases/Release-Iron-Irwini.rst b/source/Releases/Release-Iron-Irwini.rst index 9466cbf2795..596ef8a08f1 100644 --- a/source/Releases/Release-Iron-Irwini.rst +++ b/source/Releases/Release-Iron-Irwini.rst @@ -35,7 +35,7 @@ Tier 3 platforms: * macOS: ``amd64`` * Debian Bullseye: ``amd64`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ @@ -886,8 +886,8 @@ Release Timeline Release announcement. ``rosdistro`` is reopened for Iron PRs. -.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. -.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. +.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. +.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. Development progress -------------------- diff --git a/source/Releases/Release-Jazzy-Jalisco.rst b/source/Releases/Release-Jazzy-Jalisco.rst index d6238c8288f..f38f2d29490 100644 --- a/source/Releases/Release-Jazzy-Jalisco.rst +++ b/source/Releases/Release-Jazzy-Jalisco.rst @@ -35,7 +35,7 @@ Tier 3 platforms: * macOS: ``amd64`` * Debian Bookworm: ``amd64`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ @@ -660,12 +660,12 @@ Release Timeline Updated releases of ROS Desktop [2]_ packages available. Mon. May 20, 2024 - Distro Freeze - Freeze all Jazzy branches on all `ROS 2 desktop packages `__ and ``rosdistro``. + Freeze all Jazzy branches on all `ROS 2 desktop packages `__ and ``rosdistro``. No pull requests for any ``jazzy`` branch or targeting ``jazzy/distribution.yaml`` in ``rosdistro`` repo will be merged. Thu. May 23, 2024 - General Availability Release announcement. - `ROS 2 desktop packages `__ source freeze is lifted and ``rosdistro`` is reopened for Jazzy pull requests. + `ROS 2 desktop packages `__ source freeze is lifted and ``rosdistro`` is reopened for Jazzy pull requests. -.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. -.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. +.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. +.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. diff --git a/source/Releases/Release-Kilted-Kaiju.rst b/source/Releases/Release-Kilted-Kaiju.rst index b2b49d02ee9..7420df75690 100644 --- a/source/Releases/Release-Kilted-Kaiju.rst +++ b/source/Releases/Release-Kilted-Kaiju.rst @@ -37,7 +37,7 @@ Tier 3 platforms: * macOS: ``amd64`` * Debian Bookworm: ``amd64`` -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ @@ -423,12 +423,12 @@ Release Timeline Updated releases of ROS Desktop [2]_ packages available. Mon. May 19, 2025 - Distro Freeze - Freeze all Kilted branches on all `ROS 2 desktop packages `__ and ``rosdistro``. + Freeze all Kilted branches on all `ROS 2 desktop packages `__ and ``rosdistro``. No pull requests for any ``kilted`` branch or targeting ``kilted/distribution.yaml`` in ``rosdistro`` repo will be merged. Fri. May 23, 2025 - General Availability Release announcement. - `ROS 2 desktop packages `__ source freeze is lifted and ``rosdistro`` is reopened for Kilted pull requests. + `ROS 2 desktop packages `__ source freeze is lifted and ``rosdistro`` is reopened for Kilted pull requests. -.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. -.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. +.. [1] The ``ros_base`` variant is described in `REP 2001 (ros-base) `_. +.. [2] The ``desktop`` variant is described in `REP 2001 (desktop-variants) `_. diff --git a/source/Releases/Release-Lyrical-Luth.rst b/source/Releases/Release-Lyrical-Luth.rst index b8428086e58..60a8cb6e7a1 100644 --- a/source/Releases/Release-Lyrical-Luth.rst +++ b/source/Releases/Release-Lyrical-Luth.rst @@ -29,7 +29,7 @@ Tier 3 platforms: * TODO -For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. +For more information about RMW implementations, compiler / interpreter versions, and system dependency versions see `REP 2000 `__. Installation ------------ diff --git a/source/Releases/Release-Process.rst b/source/Releases/Release-Process.rst index 75d817613bc..53ce233e460 100644 --- a/source/Releases/Release-Process.rst +++ b/source/Releases/Release-Process.rst @@ -31,7 +31,7 @@ For the progress through this process for a specific release, see that release's * - Announce roadmap - The list of planned features and significant changes is made public, via a GitHub issue that will track the progress on developing each item in the roadmap. Of course, this does not mean that the roadmap is fixed at this point, as development plans can change and we always (and frequently do) welcome new contributions even if they are not on the planned roadmap. * - Set target platforms and major dependencies - - The target platforms, in terms of operating system, distribution and version, must be set far enough in advance for development work on the infrastructure (such as support in the build farm) to proceed. Similarly, the versions of each major dependency (which Python version, which compiler(s), which version of Eigen, etc.) must also be fixed. This is done via an update to `REP-2000 `__. + - The target platforms, in terms of operating system, distribution and version, must be set far enough in advance for development work on the infrastructure (such as support in the build farm) to proceed. Similarly, the versions of each major dependency (which Python version, which compiler(s), which version of Eigen, etc.) must also be fixed. This is done via an update to `REP-2000 `__. * - Add platform support to the build farm - The build farm is a critical part of the infrastructure supporting a ROS 2 distribution. It provides continuous integration facilities that help us maintain quality, and it builds the binary packages the community relies on to avoid building ROS 2 and packages from source. If the target platforms differ from the previous ROS 2 distribution, then the necessary support must be added to the build farm. * - Commission logo and related artwork diff --git a/source/Releases/Release-Rolling-Ridley.rst b/source/Releases/Release-Rolling-Ridley.rst index c36803b41ba..c552fa11402 100644 --- a/source/Releases/Release-Rolling-Ridley.rst +++ b/source/Releases/Release-Rolling-Ridley.rst @@ -13,7 +13,7 @@ Rolling Ridley (``rolling``) It is used for ROS 2 development and by maintainers who want their packages released and ready for the next stable distribution. We recommend that most users of ROS 2 use the latest `stable distribution `. -For more information see `REP-2002 `_ +For more information see `REP-2002 `_ Currently Supported Platforms ----------------------------- diff --git a/source/Tutorials/Advanced/Creating-An-RMW-Implementation.rst b/source/Tutorials/Advanced/Creating-An-RMW-Implementation.rst index 6cf04fb9943..454f5a84c02 100644 --- a/source/Tutorials/Advanced/Creating-An-RMW-Implementation.rst +++ b/source/Tutorials/Advanced/Creating-An-RMW-Implementation.rst @@ -45,7 +45,7 @@ Example implementations ^^^^^^^^^^^^^^^^^^^^^^^ The following ``rmw`` :doc:`implementations <../../Concepts/Advanced/About-Middleware-Implementations>` can be used as references. -Note that there are different `support tiers, which are defined by REP 2000 `_. +Note that there are different `support tiers, which are defined by REP 2000 `_. #. DDS: diff --git a/source/Tutorials/Advanced/Simulators/Gazebo/Gazebo.rst b/source/Tutorials/Advanced/Simulators/Gazebo/Gazebo.rst index 5f065c598ca..4b36985e539 100644 --- a/source/Tutorials/Advanced/Simulators/Gazebo/Gazebo.rst +++ b/source/Tutorials/Advanced/Simulators/Gazebo/Gazebo.rst @@ -39,7 +39,7 @@ Gazebo and ROS support different combinations of versions. All supported combinations can be seen `here `__. -`ROS REP-2000 `__ standardizes what the default version of Gazebo is for each ROS distribution. +`ROS REP-2000 `__ standardizes what the default version of Gazebo is for each ROS distribution. If you haven't installed a version of Gazebo on your system yet, you can install Gazebo by following the `installation instructions `__. diff --git a/source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst b/source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst index b16fe65b6b3..07401b4d3a7 100644 --- a/source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst +++ b/source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst @@ -295,7 +295,7 @@ You should see messages from the publisher and subscriber with numbers increment Create your own package ----------------------- -colcon uses the ``package.xml`` specification defined in `REP 149 `__ (`format 2 `__ is also supported). +colcon uses the ``package.xml`` specification defined in `REP 149 `__ (`format 2 `__ is also supported). colcon supports multiple build types. The recommended build types are ``ament_cmake`` and ``ament_python``. diff --git a/source/Tutorials/Intermediate/Rosdep.rst b/source/Tutorials/Intermediate/Rosdep.rst index ba5f6cf9afc..cd3cf8919aa 100644 --- a/source/Tutorials/Intermediate/Rosdep.rst +++ b/source/Tutorials/Intermediate/Rosdep.rst @@ -50,7 +50,7 @@ Missing or incorrect dependencies can lead to users not being able to use your p The dependencies in the ``package.xml`` file are generally referred to as "rosdep keys". These dependencies are manually populated in the ``package.xml`` file by the package's creators and should be an exhaustive list of any non-builtin libraries and packages it requires. -These are represented in the following tags (see `REP-149 `__ for the full specification): +These are represented in the following tags (see `REP-149 `__ for the full specification): ```` ^^^^^^^^^^^^ diff --git a/source/index.rst b/source/index.rst index 6f10c53fd50..2da19ed0f4e 100644 --- a/source/index.rst +++ b/source/index.rst @@ -132,7 +132,7 @@ If you need help, have an idea, or would like to contribute to the project, plea General ROS project resources ----------------------------- -* `ROS Enhancement Proposals (REPs) `__ (ROS 1, ROS 2) +* `ROS Enhancement Proposals (REPs) `__ (ROS 1, ROS 2) - Proposals for new designs and conventions @@ -189,4 +189,4 @@ Deprecated * `ROS 2 Design `__ - Early design decisions behind ROS 2 development - - New design proposals should be submitted via `ROS Enhancement Proposals (REPs) `__ + - New design proposals should be submitted via `ROS Enhancement Proposals (REPs) `__ From 53f69499b53d5b289075686f09edbfe0f93f2695 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Hern=C3=A1ndez=20Cordero?= Date: Fri, 14 Nov 2025 12:08:23 +0100 Subject: [PATCH 2/4] Update source/index.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tomoya Fujita Signed-off-by: Alejandro Hernández Cordero --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index 2da19ed0f4e..341d3ceac52 100644 --- a/source/index.rst +++ b/source/index.rst @@ -189,4 +189,4 @@ Deprecated * `ROS 2 Design `__ - Early design decisions behind ROS 2 development - - New design proposals should be submitted via `ROS Enhancement Proposals (REPs) `__ + - New design proposals should be submitted via `Robotics Enhancement Proposals (REPs) `__ From 62b1e7027cb535f4260703f6fd7b0f5d2f356379 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Hern=C3=A1ndez=20Cordero?= Date: Fri, 14 Nov 2025 12:08:29 +0100 Subject: [PATCH 3/4] Update source/index.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tomoya Fujita Signed-off-by: Alejandro Hernández Cordero --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index 341d3ceac52..09a47c5dabe 100644 --- a/source/index.rst +++ b/source/index.rst @@ -132,7 +132,7 @@ If you need help, have an idea, or would like to contribute to the project, plea General ROS project resources ----------------------------- -* `ROS Enhancement Proposals (REPs) `__ (ROS 1, ROS 2) +* `Robotics Enhancement Proposals (REPs) `__ (ROS 1, ROS 2) - Proposals for new designs and conventions From c3f33888b5f2e2a81ff31a72e51dd4fac1de8bdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Hern=C3=A1ndez=20Cordero?= Date: Fri, 14 Nov 2025 12:08:41 +0100 Subject: [PATCH 4/4] Update source/Glossary.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tomoya Fujita Signed-off-by: Alejandro Hernández Cordero --- source/Glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/Glossary.rst b/source/Glossary.rst index c6ad5ab8237..c4f425d19e4 100644 --- a/source/Glossary.rst +++ b/source/Glossary.rst @@ -21,7 +21,7 @@ Glossary of terms used throughout this documentation: A single unit of software, including source code, build system files, documentation, tests, and other associated resources. REP - ROS Enhancement Proposal. + Robotics Enhancement Proposal. A document that describes an enhancement, standardization, or convention for the ROS community. The associated REP approval process allows the community to iterate on a proposal until some consensus has been made, at which point it can be ratified and implemented, which then becomes documentation. All REPs are viewable from the `REP index `_.