Rename ROS2 to ROS 2 in all code and documentation

[ivanperez-keera]

Description

The code, the documentation, and the README use the terminology ROS2 to refer to ROS 2.

The Open Source Robotics Foundation, Inc. (OSRF) has published specific guidance on how the project should be referred to, and they have indicated that they would want it to be called ROS 2.

Type

• Bug: wrong term used in documentation, help, manual.

Additional context

None.

Requester

• Ivan Perez

Method to check presence of bug

The following grep command finds all occurrences of ROS2:

$ grep -nIHre ROS2 --exclude='CHANGELOG.md'
ogma-cli/ogma-cli.cabal:70:                       <https://ros.org Robot Operating System (ROS2)>
ogma-cli/ogma-cli.cabal:94:                     >  ros                      Generate a ROS2 monitoring application
ogma-cli/ogma-cli.cabal:106:                     - <https://ros.org/ The Robot Operating System (ROS2) web page>.
ogma-cli/src/CLI/CommandROSApp.hs:84:commandDesc = "Generate a ROS2 monitoring package"
ogma-cli/README.md:120:  ros                      Generate a ROS2 monitoring package

Note that we exclude the CHANGELOGs because it does not make much sense to edit old entries for this (it's likely better to be honest about what happened and keep past entries as they are).

Expected result

The command above should show no results.

Desired result

The command above should show no results.

Proposed solution

Rename all instances of ROS2 to ROS 2 in the code, the documentation, and the README.

Further notes

None.

[ivanperez-keera]

Change Manager: Confirmed that the issue exists.

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Issue scheduled for Ogma 1.(0+X).(8+Y).

Fix assigned to: @ivanperez-keera.

[ivanperez-keera]

Implementor: Solution implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:

  • The code proposed compiles passes the tests. Details:
    Docker image:

    FROM ubuntu:trusty
    
    ENV DEBIAN_FRONTEND=noninteractive
    
    RUN apt-get update
    
    RUN apt-get install --yes software-properties-common
    RUN add-apt-repository ppa:hvr/ghc
    RUN apt-get update
    
    RUN apt-get install --yes ghc-8.6.5 cabal-install-2.4
    RUN apt-get install --yes libz-dev
    
    ENV PATH=/opt/ghc/8.6.5/bin:/opt/cabal/2.4/bin:$PWD/.cabal-sandbox/bin:$PATH
    
    RUN cabal update
    RUN cabal v1-sandbox init
    RUN cabal v1-install alex happy
    RUN apt-get install --yes git
    
    # We install the application first and then test it, in case any tests need to
    # run the tool.
    CMD git clone $REPO && \
        cd $NAME && \
        git checkout $COMMIT && \
        cd .. && \
        cabal v1-install $NAME/$PAT**/ --enable-tests && \
        cabal v1-install $NAME/$PAT**/ --enable-tests --run-tests -j1

    Command:

    $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=7ab58a8e7a3cf118c87d6eb29df9ab5b40fa7083" -it ogma-test

  • The solution proposed fixes the issues described. Details:
    The following docker script prints Success if the text ROS2 is not found in any files except for changelog files, and nothing otherwise.

    FROM ubuntu:focal
    
    RUN apt-get update
    
    RUN apt-get install --yes git
    
    SHELL ["/bin/bash", "-c"]
    CMD git clone $REPO \
        && cd $NAME \
        && git checkout $COMMIT \
        && ! grep -nIHre 'ROS2' --exclude='CHANGELOG.md' \
        && echo "Success"

    Command:

    $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=7ab58a8e7a3cf118c87d6eb29df9ab5b40fa7083" -it ogma-verify-83

• Implementation is documented. Details:
  All instances of the incorrect name replaced in README and package descriptions.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No examples affected.
• Required version bumps are evaluated. Details:
  No bump needed (change to help/documentation term, not affecting functional aspects of the interface).

[ivanperez-keera]

Change Manager: Implementation ready to be merged.