Add $ to Installation/Alternatives (#5354)

Signed-off-by: Nils-Christian Iseke <[email protected]>
Signed-off-by: Nils-Christian Iseke <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
(cherry picked from commit 2901e65)

# Conflicts:
#	source/Installation/Alternatives/RHEL-Development-Setup.rst
#	source/Installation/Alternatives/RHEL-Install-Binary.rst
#	source/Installation/Alternatives/Ubuntu-Development-Setup.rst
#	source/Installation/Alternatives/Ubuntu-Install-Binary.rst
#	source/Installation/Alternatives/Windows-Development-Setup.rst
#	source/Installation/Alternatives/macOS-Development-Setup.rst

Author: Nils-ChristianIseke

source/Installation/Alternatives/RHEL-Development-Setup.rst

@@ -39,16 +39,30 @@ They can be enabled by running:
    sudo dnf install 'dnf-command(config-manager)' epel-release -y
    sudo dnf config-manager --set-enabled powertools
 
+<<<<<<< HEAD
 .. note:: This step may be slightly different depending on the distribution you are using.
           `Check the EPEL documentation <https://docs.fedoraproject.org/en-US/epel/#_quickstart>`_
+=======
+    .. code-block:: console
+
+      $ sudo dnf install 'dnf-command(config-manager)' epel-release -y
+      $ sudo dnf config-manager --set-enabled crb
+
+    .. note:: This step may be slightly different depending on the distribution you are using.
+              `Check the EPEL documentation <https://docs.fedoraproject.org/en-US/epel/#_quickstart>`_
+
+  .. group-tab:: Fedora
+
+    No additional setup required.
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 
 Install development tools and ROS tools
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. code-block:: bash
+.. code-block:: console
 
-   sudo dnf install -y \
+   $ sudo dnf install -y \
      cmake \
      gcc-c++ \
      git \
@@ -64,9 +78,9 @@ Install development tools and ROS tools
      python3-setuptools \
      python3-vcstool
 
-   # install some pip packages needed for testing and
-   # not available as RPMs
-   python3 -m pip install -U --user \
+   ~ install some pip packages needed for testing and
+   ~ not available as RPMs
+   $ python3 -m pip install -U --user \
      flake8-blind-except==0.1.1 \
      flake8-builtins \
      flake8-class-newline \
@@ -84,11 +98,11 @@ Get ROS 2 code
 
 Create a workspace and clone all repos:
 
-.. code-block:: bash
+.. code-block:: console
 
-   mkdir -p ~/ros2_{DISTRO}/src
-   cd ~/ros2_{DISTRO}
-   vcs import --input https://raw.githubusercontent.com/ros2/ros2/{REPOS_FILE_BRANCH}/ros2.repos src
+   $ mkdir -p ~/ros2_{DISTRO}/src
+   $ cd ~/ros2_{DISTRO}
+   $ vcs import --input https://raw.githubusercontent.com/ros2/ros2/{REPOS_FILE_BRANCH}/ros2.repos src
 
 .. _rhel-development-setup-install-dependencies-using-rosdep:
 
@@ -97,11 +111,17 @@ Install dependencies using rosdep
 
 .. include:: ../_Dnf-Update-Admonition.rst
 
-.. code-block:: bash
+.. code-block:: console
 
+<<<<<<< HEAD
    sudo rosdep init
    rosdep update
    rosdep install --from-paths src --ignore-src -y --skip-keys "asio cyclonedds fastcdr fastrtps ignition-cmake2 ignition-math6 python3-babeltrace python3-mypy rti-connext-dds-6.0.1 urdfdom_headers"
+=======
+   $ sudo rosdep init
+   $ rosdep update
+   $ rosdep install --from-paths src --ignore-src -y --skip-keys "fastcdr rti-connext-dds-7.3.0 urdfdom_headers"
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 Install additional DDS implementations (optional)
 -------------------------------------------------
@@ -118,28 +138,47 @@ The output should be empty.
 
 More info on working with a ROS workspace can be found in :doc:`this tutorial <../../Tutorials/Beginner-Client-Libraries/Colcon-Tutorial>`.
 
-.. code-block:: bash
+.. code-block:: console
 
+<<<<<<< HEAD
    cd ~/ros2_{DISTRO}/
    colcon build --symlink-install --cmake-args -DTHIRDPARTY_Asio=ON -DPython3_EXECUTABLE=/usr/bin/python3 --no-warn-unused-cli
+=======
+   $ cd ~/ros2_{DISTRO}/
+   $ colcon build --symlink-install
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 Note: if you are having trouble compiling all examples and this is preventing you from completing a successful build, you can use ``COLCON_IGNORE`` in the same manner as `CATKIN_IGNORE <https://github.com/ros-infrastructure/rep/blob/master/rep-0128.rst>`__ to ignore the subtree or remove the folder from the workspace.
 Take for instance: you would like to avoid installing the large OpenCV library.
 Well then simply run ``touch COLCON_IGNORE`` in the ``cam2image`` demo directory to leave it out of the build process.
 
+<<<<<<< HEAD
 Environment setup
+=======
+   If you are having trouble compiling all examples and this is preventing you from completing a successful build, you can use the ``--packages-skip`` colcon flag to ignore the package that is causing problems.
+   For instance, if you don't want to install the large OpenCV library, you could skip building the packages that depend on it using the command:
+
+   .. code-block:: console
+
+      $ colcon build --symlink-install --packages-skip image_tools intra_process_demo
+
+Setup environment
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 -----------------
 
 Source the setup script
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 Set up your environment by sourcing the following file.
 
-.. code-block:: bash
+.. code-block:: console
+
+   $ . ~/ros2_{DISTRO}/install/local_setup.bash
 
-   # Replace ".bash" with your shell if you're not using bash
-   # Possible values are: setup.bash, setup.sh, setup.zsh
-   . ~/ros2_{DISTRO}/install/local_setup.bash
+.. note::
+
+   Replace ``.bash`` with your shell if you're not using bash.
+   Possible values are: ``setup.bash``, ``setup.sh``, ``setup.zsh``.
 
 .. _rhel_talker-listener:
 
@@ -148,17 +187,17 @@ Try some examples
 
 In one terminal, source the setup file and then run a C++ ``talker``\ :
 
-.. code-block:: bash
+.. code-block:: console
 
-   . ~/ros2_{DISTRO}/install/local_setup.bash
-   ros2 run demo_nodes_cpp talker
+   $ . ~/ros2_{DISTRO}/install/local_setup.bash
+   $ ros2 run demo_nodes_cpp talker
 
 In another terminal source the setup file and then run a Python ``listener``\ :
 
-.. code-block:: bash
+.. code-block:: console
 
-   . ~/ros2_{DISTRO}/install/local_setup.bash
-   ros2 run demo_nodes_py listener
+   $ . ~/ros2_{DISTRO}/install/local_setup.bash
+   $ ros2 run demo_nodes_py listener
 
 You should see the ``talker`` saying that it's ``Publishing`` messages and the ``listener`` saying ``I heard`` those messages.
 This verifies both the C++ and Python APIs are working properly.
@@ -184,12 +223,12 @@ Clang
 
 To configure CMake to detect and use Clang:
 
-.. code-block:: bash
+.. code-block:: console
 
-   sudo dnf install clang
-   export CC=clang
-   export CXX=clang++
-   colcon build --cmake-force-configure
+   $ sudo dnf install clang
+   $ export CC=clang
+   $ export CXX=clang++
+   $ colcon build --cmake-force-configure
 
 Stay up to date
 ---------------
@@ -209,6 +248,6 @@ Uninstall
 
 2. If you're also trying to free up space, you can delete the entire workspace directory with:
 
-   .. code-block:: bash
+   .. code-block:: console
 
-    rm -rf ~/ros2_{DISTRO}
+    $ rm -rf ~/ros2_{DISTRO}

source/Installation/Alternatives/RHEL-Install-Binary.rst

@@ -26,10 +26,15 @@ Enable required repositories
 The rosdep database contains packages from the EPEL and PowerTools repositories, which are not enabled by default.
 They can be enabled by running:
 
-.. code-block:: bash
+.. code-block:: console
 
+<<<<<<< HEAD
    sudo dnf install 'dnf-command(config-manager)' epel-release -y
    sudo dnf config-manager --set-enabled powertools
+=======
+   $ sudo dnf install 'dnf-command(config-manager)' epel-release -y
+   $ sudo dnf config-manager --set-enabled crb
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 .. note:: This step may be slightly different depending on the distribution you are using.
           `Check the EPEL documentation <https://docs.fedoraproject.org/en-US/epel/#_quickstart>`_
@@ -39,12 +44,51 @@ Installing prerequisites
 
 There are a few packages that must be installed in order to get and unpack the binary release.
 
-.. code-block:: bash
+.. code-block:: console
 
-   sudo dnf install tar bzip2 wget -y
+   $ sudo dnf install tar bzip2 wget -y
 
+<<<<<<< HEAD
 Downloading ROS 2
 -----------------
+=======
+Install development tools (optional)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you are going to build ROS packages or otherwise do development, you can also install the development tools:
+
+.. code-block:: console
+
+   $ sudo dnf install -y \
+     cmake \
+     gcc-c++ \
+     git \
+     make \
+     patch \
+     python3-colcon-common-extensions \
+     python3-mypy \
+     python3-pip \
+     python3-pytest \
+     python3-pytest-repeat \
+     python3-pytest-rerunfailures \
+     python3-rosdep \
+     python3-setuptools \
+     python3-vcstool \
+     wget
+
+   ~ install some pip packages needed for testing and
+   ~ not available as RPMs
+   $ python3 -m pip install -U --user \
+     flake8-blind-except==0.1.1 \
+     flake8-class-newline \
+     flake8-deprecated
+
+Install ROS 2
+-------------
+
+Binary releases of Rolling Ridley are not provided.
+Instead you may download nightly :ref:`prerelease binaries <Prerelease_binaries>`.
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 * Go to the `releases page <https://github.com/ros2/ros2/releases>`_
 * Download the latest package for RHEL; let's assume that it ends up at ``~/Downloads/ros2-package-linux-x86_64.tar.bz2``.
@@ -53,20 +97,32 @@ Downloading ROS 2
 
 * Unpack it:
 
-  .. code-block:: bash
+  .. code-block:: console
 
+<<<<<<< HEAD
        mkdir -p ~/ros2_{DISTRO}
        cd ~/ros2_{DISTRO}
        tar xf ~/Downloads/ros2-package-linux-x86_64.tar.bz2
+=======
+     $ mkdir -p ~/ros2_{DISTRO}
+     $ cd ~/ros2_{DISTRO}
+     $ tar xf ~/Downloads/ros2-package-linux-x86_64.tar.bz2
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 Installing and initializing rosdep
 ----------------------------------
 
-.. code-block:: bash
+.. code-block:: console
 
+<<<<<<< HEAD
        sudo dnf install -y python3-rosdep
        sudo rosdep init
        rosdep update
+=======
+   $ sudo rosdep init
+   $ rosdep update
+   $ rosdep install --from-paths ~/ros2_{DISTRO}/ros2-linux/share --ignore-src -y --skip-keys "cyclonedds fastcdr fastrtps iceoryx_binding_c rti-connext-dds-7.3.0 urdfdom_headers"
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 .. _rhel-install-binary-install-missing-dependencies:
 
@@ -94,28 +150,37 @@ Source the setup script
 
 Set up your environment by sourcing the following file.
 
-.. code-block:: bash
+.. code-block:: console
 
+<<<<<<< HEAD
    # Replace ".bash" with your shell if you're not using bash
    # Possible values are: setup.bash, setup.sh, setup.zsh
   . ~/ros2_{DISTRO}/ros2-linux/setup.bash
+=======
+   $ . ~/ros2_{DISTRO}/ros2-linux/setup.bash
+
+.. note::
+
+   Replace ``.bash`` with your shell if you're not using bash.
+   Possible values are: ``setup.bash``, ``setup.sh``, ``setup.zsh``.
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))
 
 Try some examples
 -----------------
 
 In one terminal, source the setup file and then run a C++ ``talker``:
 
-.. code-block:: bash
+.. code-block:: console
 
-   . ~/ros2_{DISTRO}/ros2-linux/setup.bash
-   ros2 run demo_nodes_cpp talker
+   $ . ~/ros2_{DISTRO}/ros2-linux/setup.bash
+   $ ros2 run demo_nodes_cpp talker
 
 In another terminal source the setup file and then run a Python ``listener``:
 
-.. code-block:: bash
+.. code-block:: console
 
-   . ~/ros2_{DISTRO}/ros2-linux/setup.bash
-   ros2 run demo_nodes_py listener
+   $ . ~/ros2_{DISTRO}/ros2-linux/setup.bash
+   $ ros2 run demo_nodes_py listener
 
 You should see the ``talker`` saying that it's ``Publishing`` messages and the ``listener`` saying ``I heard`` those messages.
 This verifies both the C++ and Python APIs are working properly.
@@ -143,6 +208,10 @@ Uninstall
 
 2. If you're also trying to free up space, you can delete the entire workspace directory with:
 
-   .. code-block:: bash
+   .. code-block:: console
 
+<<<<<<< HEAD
     rm -rf ~/ros2_{DISTRO}
+=======
+      $ rm -rf ~/ros2_{DISTRO}
+>>>>>>> 2901e65 (Add $ to Installation/Alternatives (#5354))