Skip to content

Commit

Permalink
Update Ubuntu installation references and redirects
Browse files Browse the repository at this point in the history
  • Loading branch information
cottsay committed Apr 1, 2021
1 parent 95002f2 commit 2494d2d
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 16 deletions.
6 changes: 3 additions & 3 deletions source/Guides/Cross-compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The ``toolchain-file`` provide to CMake the information of the ``cross-compiler`

Cross-compiling examples for Arm
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
After `downloading the ROS 2 source code <../../Installation/Linux-Development-Setup>`__, you can add cross-compilation assets to the workspace via ``git clone https://github.com/ros-tooling/cross_compile.git -b 0.0.1 src/ros2/cross_compile``. These are working examples on how to cross-compile for Arm cores.
After `downloading the ROS 2 source code <../Installation/Ubuntu-Development-Setup>`, you can add cross-compilation assets to the workspace via ``git clone https://github.com/ros-tooling/cross_compile.git -b 0.0.1 src/ros2/cross_compile``. These are working examples on how to cross-compile for Arm cores.

The following targets are supported:
- Ubuntu-arm64: To be used with any ARMv8-A based system.
Expand Down Expand Up @@ -161,7 +161,7 @@ It will be used to install the ROS 2 dependencies on the target file-system with
mkdir qemu-user-static
cp /usr/bin/qemu-*-static qemu-user-static
The standard `setup <../../Installation/Linux-Development-Setup>`__ process of ROS 2 is run inside an arm docker. This is possible thanks to ``qemu-static``, which will emulate an arm machine. The base image used is an Ubuntu Bionic from Docker Hub.
The standard `setup <../Installation/Ubuntu-Development-Setup>` process of ROS 2 is run inside an arm docker. This is possible thanks to ``qemu-static``, which will emulate an arm machine. The base image used is an Ubuntu Bionic from Docker Hub.

.. code-block:: bash
Expand Down Expand Up @@ -271,7 +271,7 @@ Instead of downloading the ROS 2 stack, just populate your workspace with your p
git clone https://github.com/ros-tooling/cross_compile.git -b 0.0.1
cd ..
Generate and export the file-system as described in `3. Prepare the sysroot`_, but with the provided ``Dockerfile_ubuntu_arm64_prebuilt``. These ``_prebuilt`` Dockerfile will use the `binary packages <../Installation/Linux-Install-Debians>` to install ROS 2 instead of building from source.
Generate and export the file-system as described in `3. Prepare the sysroot`_, but with the provided ``Dockerfile_ubuntu_arm64_prebuilt``. These ``_prebuilt`` Dockerfile will use the `binary packages <../Installation/Ubuntu-Install-Debians>` to install ROS 2 instead of building from source.

Modify the environment variable ``ROS2_INSTALL_PATH`` to point to the installation directory:

Expand Down
12 changes: 6 additions & 6 deletions source/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Options for installing ROS 2 Rolling Ridley:
:hidden:
:glob:

Installation/Linux-Development-Setup
Installation/Linux-Install-Binary
Installation/Linux-Install-Debians
Installation/Ubuntu-Development-Setup
Installation/Ubuntu-Install-Binary
Installation/Ubuntu-Install-Debians
Installation/macOS-Development-Setup
Installation/macOS-Install-Binary
Installation/Windows-Development-Setup
Expand All @@ -30,8 +30,8 @@ We currently provide ROS 2 binary packages for the following platforms:

* Linux (Ubuntu Focal(20.04))

* `Debian packages <Installation/Linux-Install-Debians>`
* `"fat" archive <Installation/Linux-Install-Binary>`
* `Debian packages <Installation/Ubuntu-Install-Debians>`
* `"fat" archive <Installation/Ubuntu-Install-Binary>`

* `macOS <Installation/macOS-Install-Binary>`
* `Windows <Installation/Windows-Install-Binary>`
Expand All @@ -47,7 +47,7 @@ Building from source
We support building ROS 2 from source on the following platforms:


* `Linux <Installation/Linux-Development-Setup>`
* `Linux <Installation/Ubuntu-Development-Setup>`
* `macOS <Installation/macOS-Development-Setup>`
* `Windows <Installation/Windows-Development-Setup>`

Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Latest-Development-Setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Building from source

Follow the links below for the latest setup instructions for your platform:

* `Linux <Linux-Development-Setup>`
* `Linux <Ubuntu-Development-Setup>`
* `macOS <macOS-Development-Setup>`
* `Windows <Windows-Development-Setup>`

Expand Down
6 changes: 5 additions & 1 deletion source/Installation/Ubuntu-Development-Setup.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
.. _linux-latest:

.. redirect-from::

Installation/Linux-Development-Setup

Building ROS 2 on Linux
=======================

Expand Down Expand Up @@ -29,7 +33,7 @@ System setup
Set locale
^^^^^^^^^^

.. include:: _Linux-Set-Locale.rst
.. include:: _Ubuntu-Set-Locale.rst

Add the ROS 2 apt repository
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
6 changes: 5 additions & 1 deletion source/Installation/Ubuntu-Install-Binary.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. redirect-from::

Installation/Linux-Install-Binary

Installing ROS 2 on Linux
=========================

Expand All @@ -13,7 +17,7 @@ This page explains how to install ROS 2 on Linux from a pre-built binary package
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.
The exact list of packages are described by the repositories listed in `this ros2.repos file <https://github.com/ros2/ros2/blob/master/ros2.repos>`_.

There are also `Debian packages <Linux-Install-Debians>` available.
There are also `Debian packages <Ubuntu-Install-Debians>` available.

System Requirements
-------------------
Expand Down
6 changes: 5 additions & 1 deletion source/Installation/Ubuntu-Install-Debians.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. redirect-from::

Installation/Linux-Install-Debians

Installing ROS 2 via Debian Packages
====================================

Expand All @@ -23,7 +27,7 @@ Resources
Set locale
----------

.. include:: _Linux-Set-Locale.rst
.. include:: _Ubuntu-Set-Locale.rst

.. _linux-install-debians-setup-sources:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Building ROS 2 on Linux with Eclipse Oxygen [community-contributed]
If the steps work for you please leave a comment on https://github.com/ros2/ros2/issues/495 .
If the steps don't work then please comment with the first step that didn't work.**

This tutorial is based on a clean ubuntu-16.04.2 install and eclipse oxygen with egit. It uses RTI Connext as middleware for Realtime performance. The `original Install page <../Installation/Linux-Development-Setup>` is perhaps more up-to-date, so check it for info.
This tutorial is based on a clean ubuntu-16.04.2 install and eclipse oxygen with egit. It uses RTI Connext as middleware for Realtime performance. The `original Install page <../Installation/Ubuntu-Development-Setup>` is perhaps more up-to-date, so check it for info.

Install:

Expand Down Expand Up @@ -86,7 +86,7 @@ Add export RTI_LICENSE_FILE=/home/ros/rti_connext_dds-5.3.1/rti_license.dat to .


An RTI license is now needed, which we can get on their website.
Refer to `Linux Development Setup page <../Installation/Linux-Development-Setup>`.
Refer to `Linux Development Setup page <../Installation/Ubuntu-Development-Setup>`.
The RTI license file will be directly sent via email after sign-up.

In the email is a link to the RTI software to download.
Expand Down
2 changes: 1 addition & 1 deletion source/Tutorials/Real-Time-Programming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Since many of the operations done in the demo to optimize performance or OS-spec

Also this must be built from source using a the static DDS API. **Currently the only supported implementation is Connext**.

First, follow the instructions to build ROS 2 `from source <../Installation/Linux-Development-Setup>` using Connext DDS as the middleware.
First, follow the instructions to build ROS 2 `from source <../Installation/Ubuntu-Development-Setup>` using Connext DDS as the middleware.

Run the tests
^^^^^^^^^^^^^
Expand Down

0 comments on commit 2494d2d

Please sign in to comment.