Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/Concepts/Advanced/About-Build-System.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://www.ros.org/reps/rep-0127.html>`_ and `140 <http://www.ros.org/reps/rep-0140.html>`_, 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 <https://reps.openrobotics.org/rep-0127/>`_ and `140 <https://reps.openrobotics.org/rep-0140/>`_, 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.

Expand Down
4 changes: 2 additions & 2 deletions source/Glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ 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 <https://www.ros.org/reps/rep-0000.html>`_.
All REPs are viewable from the `REP index <https://reps.openrobotics.org/>`_.

VCS
Version Control System, such as CVS, SVN, git, mercurial, etc...
Expand Down
2 changes: 1 addition & 1 deletion source/How-To-Guides/Ament-CMake-Documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html>`__.
Newer versions might be targeted in the future and are referenced `here <https://reps.openrobotics.org/rep-2000/>`__.
Therefore it is customary to set the corresponding CMake flags:

.. code-block:: cmake
Expand Down
6 changes: 3 additions & 3 deletions source/How-To-Guides/Installing-on-Raspberry-Pi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html>`__ that arm64 receives Tier 1 support, while arm32 is Tier 3.
However, you can see `here <https://reps.openrobotics.org/rep-2000/>`__ 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.
Expand All @@ -14,7 +14,7 @@ Ubuntu Linux on Raspberry Pi with binary ROS 2 install

Ubuntu for Raspberry Pi is available `here <https://ubuntu.com/download/raspberry-pi>`__.

Make sure to confirm that you have selected the correct version as described in `REP-2000 <https://www.ros.org/reps/rep-2000.html>`__.
Make sure to confirm that you have selected the correct version as described in `REP-2000 <https://reps.openrobotics.org/rep-2000/>`__.

You can now install ROS 2 using the normal binary installation instructions for Ubuntu Linux.

Expand All @@ -30,7 +30,7 @@ After flashing the OS, `install Docker <https://docs.docker.com/engine/install/d
The official ROS 2 Docker images can be found `here <https://hub.docker.com/_/ros/tags>`__.

You may choose from ros-core, ros-base, or perception.
See `here <https://www.ros.org/reps/rep-2001.html>`__ for more information on these variants.
See `here <https://reps.openrobotics.org/rep-2001/>`__ for more information on these variants.

Fetch and run an image:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html>`__.
Use a newer C++ standard matching the version used by your target ROS distro in `REP 2000 <https://reps.openrobotics.org/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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html>`__, and use that version at the top of your ``CMakeLists.txt``.
For example, `3.14.4 is the minimum recommended support for ROS Humble <https://www.ros.org/reps/rep-2000.html#humble-hawksbill-may-2022-may-2027>`__.
Find the minimum version of CMake used by the ROS distribution you want to support in `REP 2000 <https://reps.openrobotics.org/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 <https://reps.openrobotics.org/rep-2000/#humble-hawksbill-may-2022-may-2027>`__.

.. code-block::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-0140.html>`__.
ROS 2 requires ``package.xml`` files to use at least `format 2 <https://reps.openrobotics.org/rep-0140/>`__.
This guide shows how to migrate a ``package.xml`` from format 1 to format 2.

If the ``<package>`` 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.
Expand All @@ -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 <https://www.ros.org/reps/rep-0140.html#compatibility>`__ for a summary of the differences.
Read the `compatibility section in REP-0140 <https://reps.openrobotics.org/rep-0140/#compatibility>`__ for a summary of the differences.

Add ``format`` attribute to ``<package>``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions source/How-To-Guides/Releasing/Index-Your-Packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-0144.html>`__.
Packages released into a ROS distribution must have names that comply with `REP 144 <https://reps.openrobotics.org/rep-0144/>`__.
Read the full REP to understand the rules.
If one of your ROS package names doesn't comply, then change the name before continuing.

Expand Down Expand Up @@ -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 <https://github.com/ros2/rosidl>`__ 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 <https://www.ros.org/reps/rep-0141.html#distribution-file>`__.
* YOUR-STATUS: This is a status from the list in `REP 141 <https://reps.openrobotics.org/rep-0141/#distribution-file>`__.
You likely want either ``maintained`` or ``developed``.

Open a pull request to ros/rosdistro
Expand Down
2 changes: 1 addition & 1 deletion source/How-To-Guides/Releasing/Release-Team-Repository.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/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 <https://www.ros.org/reps/rep-0144.html>`_ 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 <https://reps.openrobotics.org/rep-0144/>`_ and other requirements before release.
Once your package name has been approved and merged, fill in the `Add New Release Repositories issue <https://github.com/ros2-gbp/ros2-gbp-github-org/issues/new?assignees=&labels=&template=new_release_repository.md&title=Add+new+release+repositories>`_ issue template
if you don't have a release repo for your project yet.

Expand Down
2 changes: 1 addition & 1 deletion source/How-To-Guides/Releasing/Releasing-a-Package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2000.html>`_.
* 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 <https://reps.openrobotics.org/rep-2000/>`_.
* Allow your package to have API documentation automatically generated.
* Make your package part of the `ROS Index <https://index.ros.org>`_.
* (Optionally) Allow you to have automatic CI run for pull requests in your repository.
Expand Down
4 changes: 2 additions & 2 deletions source/How-To-Guides/Using-Variants.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2001.html>`_.
The different variants in ROS 2 are specified in `REP-2001 <https://reps.openrobotics.org/rep-2001/>`_.

In addition to the official variants, there may be metapackages for specific institutions or robots as described in `REP-108 <https://www.ros.org/reps/rep-0108.html#institution-specific>`_.
In addition to the official variants, there may be metapackages for specific institutions or robots as described in `REP-108 <https://reps.openrobotics.org/rep-0108/#institution-specific>`_.

Adding variants
---------------
Expand Down
2 changes: 1 addition & 1 deletion source/How-To-Guides/Using-ros1_bridge-Jammy-upstream.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-0003.html#noetic-ninjemys-may-2020-may-2025>`__, 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 <https://reps.openrobotics.org/rep-0003/#noetic-ninjemys-may-2020---may-2025>`__, it will only target Ubuntu 20.04.
Alternatively, there are `upstream variants of ROS 1 packages <https://packages.ubuntu.com/jammy/ros-desktop>`__ 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html#platforms-by-distribution>`_.
The default RMW for each ROS Distro can be found in `REP-2000 <https://reps.openrobotics.org/rep-2000/#platforms-by-distribution>`_.

Ensuring use of a particular RMW implementation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion source/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html#rolling-ridley-june-2020-ongoing>`__.
Binaries are only created for the Tier 1 operating systems listed in `REP-2000 <https://reps.openrobotics.org/rep-2000/#rolling-ridley-june-2020---ongoing>`__.
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 <How-To-Guides/Run-2-nodes-in-single-or-separate-docker-containers>` to run ROS 2 on your platform.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html>`_.
As defined in `REP 2000 <https://reps.openrobotics.org/rep-2000/>`_.

System setup
------------
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Alternatives/RHEL-Install-Binary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2001.html#ros-base>`_ are included, and only a subset of packages in the `ROS desktop variant <https://ros.org/reps/rep-2001.html#desktop-variants>`_ are included.
All packages in the `ROS base variant <https://reps.openrobotics.org/rep-2001/#ros-base>`_ are included, and only a subset of packages in the `ROS desktop variant <https://reps.openrobotics.org/rep-2001/#desktop-variants>`_ are included.
The exact list of packages are described by the repositories listed in `this ros2.repos file <https://github.com/ros2/ros2/blob/{REPOS_FILE_BRANCH}/ros2.repos>`_.

There are also :doc:`RPM packages <../RHEL-Install-RPMs>` available.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-2000.html>`_.
As defined in `REP 2000 <https://reps.openrobotics.org/rep-2000/>`_.

System setup
------------
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Alternatives/Ubuntu-Install-Binary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2001.html#ros-base>`_ are included, and only a subset of packages in the `ROS desktop variant <https://ros.org/reps/rep-2001.html#desktop-variants>`_ are included.
All packages in the `ROS base variant <https://reps.openrobotics.org/rep-2001/#ros-base>`_ are included, and only a subset of packages in the `ROS desktop variant <https://reps.openrobotics.org/rep-2001/#desktop-variants>`_ are included.
The exact list of packages are described by the repositories listed in `this ros2.repos file <https://github.com/ros2/ros2/blob/{REPOS_FILE_BRANCH}/ros2.repos>`_.

There are also :doc:`deb packages <../Ubuntu-Install-Debs>` available.
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/RHEL-Install-RPMs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2000.html>`__.
The target platforms are defined in `REP 2000 <https://reps.openrobotics.org/rep-2000/>`__.
Most people will want to use a stable ROS distribution.

Resources
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/RMW-Implementations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2000.html>`__ for supported RMW vendors by distribution.
See `REP-2000 <https://reps.openrobotics.org/rep-2000/>`__ for supported RMW vendors by distribution.

The default RMW vendor is eProsima's Fast DDS.

Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Ubuntu-Install-Debs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2000.html>`__.
The target platforms are defined in `REP 2000 <https://reps.openrobotics.org/rep-2000/>`__.
Most people will want to use a stable ROS distribution.

Resources
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Windows-Install-Binary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ros.org/reps/rep-2001.html#ros-base>`_ are included, and only a subset of packages in the `ROS desktop variant <https://ros.org/reps/rep-2001.html#desktop-variants>`_ are included.
All packages in the `ROS base variant <https://reps.openrobotics.org/rep-2001/#ros-base>`_ are included, and only a subset of packages in the `ROS desktop variant <https://reps.openrobotics.org/rep-2001/#desktop-variants>`_ are included.
The exact list of packages are described by the repositories listed in `this ros2.repos file <https://github.com/ros2/ros2/blob/{REPOS_FILE_BRANCH}/ros2.repos>`_.

System requirements
Expand Down
2 changes: 1 addition & 1 deletion source/Releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ Rolling Distribution
--------------------

:doc:`ROS 2 Rolling Ridley <Releases/Release-Rolling-Ridley>` is the rolling development distribution of ROS 2.
It is described in `REP 2002 <https://www.ros.org/reps/rep-2002.html>`_ and was first introduced in June 2020.
It is described in `REP 2002 <https://reps.openrobotics.org/rep-2002/>`_ and was first introduced in June 2020.

The Rolling distribution of ROS 2 serves two purposes:

Expand Down
2 changes: 1 addition & 1 deletion source/Releases/Release-Ardent-Apalone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.ros.org/reps/rep-0149.html>`__ specifying format 3 of the package manifest files
* Draft implementation of `REP 149 <https://reps.openrobotics.org/rep-0149/>`__ specifying format 3 of the package manifest files

Known Issues
------------
Expand Down
2 changes: 1 addition & 1 deletion source/Releases/Release-Bouncy-Bolson.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Bouncy Bolson (``bouncy``)
Supported Platforms
-------------------

This version of ROS 2 is supported on four platforms (see `REP 2000 <https://www.ros.org/reps/rep-2000.html#bouncy-bolson-june-2018-june-2019>`__ for full details):
This version of ROS 2 is supported on four platforms (see `REP 2000 <https://reps.openrobotics.org/rep-2000/#bouncy-bolson-june-2018-june-2019>`__ for full details):


* Ubuntu 18.04 (Bionic)
Expand Down
2 changes: 1 addition & 1 deletion source/Releases/Release-Crystal-Clemmys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Crystal Clemmys (``crystal``)
Supported Platforms
-------------------

Crystal Clemmys is primarily supported on the following platforms (see `REP 2000 <https://www.ros.org/reps/rep-2000.html#crystal-clemmys-december-2018-december-2019>`__ for full details):
Crystal Clemmys is primarily supported on the following platforms (see `REP 2000 <https://reps.openrobotics.org/rep-2000/#crystal-clemmys-december-2018-december-2019>`__ for full details):

Tier 1 platforms:

Expand Down
Loading