Add recommendation to update systems before installing ROS 2. (#2581)

* Add recommendation to update systems before installing ROS 2. Installing ROS 2 packages without updating the system first can lead to conflicts due to package version differences. This is generally useful but of particular importance on Ubuntu Jammy: ros2/ros2#1272 * Add system upgrade admonition to alternative installation methods. * Extract upgrade admonitions into a snippet. * Add upgrade admonitions to alternative installation methods. (cherry picked from commit b4527c0)
ros2 · May 19, 2022 · bf0931a · bf0931a
1 parent 4da2105
commit bf0931a
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 0 deletions.
diff --git a/source/Installation/Alternatives/RHEL-Development-Setup.rst b/source/Installation/Alternatives/RHEL-Development-Setup.rst
@@ -92,6 +92,8 @@ Create a workspace and clone all repos:
 Install dependencies using rosdep
 ---------------------------------
 
+.. include:: ../_Dnf-Update-Admonition.rst
+
 .. code-block:: bash
 
    sudo rosdep init

diff --git a/source/Installation/Alternatives/RHEL-Install-Binary.rst b/source/Installation/Alternatives/RHEL-Install-Binary.rst
@@ -70,6 +70,8 @@ Installing and initializing rosdep
 Installing the missing dependencies
 -----------------------------------
 
+.. include:: ../_Dnf-Update-Admonition.rst
+
 Set your rosdistro according to the release you downloaded.
 
 .. code-block:: bash

diff --git a/source/Installation/Alternatives/Ubuntu-Development-Setup.rst b/source/Installation/Alternatives/Ubuntu-Development-Setup.rst
@@ -91,6 +91,8 @@ Create a workspace and clone all repos:
 Install dependencies using rosdep
 ---------------------------------
 
+.. include:: ../_Apt-Upgrade-Admonition.rst
+
 .. code-block:: bash
 
    sudo rosdep init

diff --git a/source/Installation/Alternatives/Ubuntu-Install-Binary.rst b/source/Installation/Alternatives/Ubuntu-Install-Binary.rst
@@ -61,6 +61,8 @@ Installing and initializing rosdep
 Installing the missing dependencies
 -----------------------------------
 
+.. include:: ../_Apt-Upgrade-Admonition.rst
+
 Set your rosdistro according to the release you downloaded.
 
 .. code-block:: bash

diff --git a/source/Installation/RHEL-Install-RPMs.rst b/source/Installation/RHEL-Install-RPMs.rst
@@ -53,6 +53,8 @@ DNF may prompt you to verify the GPG key, which should match the location ``http
 Install ROS 2 packages
 ----------------------
 
+.. include:: _Dnf-Update-Admonition.rst
+
 Desktop Install (Recommended): ROS, RViz, demos, tutorials.
 
 .. code-block:: bash

diff --git a/source/Installation/Ubuntu-Install-Debians.rst b/source/Installation/Ubuntu-Install-Debians.rst
@@ -44,6 +44,8 @@ Update your apt repository caches after setting up the repositories.
 
    sudo apt update
 
+.. include:: _Apt-Upgrade-Admonition.rst
+
 Desktop Install (Recommended): ROS, RViz, demos, tutorials.
 
 .. code-block:: bash

diff --git a/source/Installation/_Apt-Upgrade-Admonition.rst b/source/Installation/_Apt-Upgrade-Admonition.rst
@@ -0,0 +1,7 @@
+ROS 2 packages are built on frequently updated Ubuntu systems.
+It is always recommended that you ensure your system is up to date before installing new packages.
+
+.. code-block:: bash
+
+   sudo apt upgrade
+
diff --git a/source/Installation/_Dnf-Update-Admonition.rst b/source/Installation/_Dnf-Update-Admonition.rst
@@ -0,0 +1,7 @@
+ROS 2 packages are built on frequently updated RHEL systems.
+It is always recommended that you ensure your system is up to date before installing new packages.
+
+.. code-block:: bash
+
+   sudo dnf update
+