Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop-rename-ros-2' into develop. Close #83.
**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: ```sh $ 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). The following docker script prints `Success` if the text ROS2 is not found in any files except for changelog files, and nothing otherwise. ```Dockerfile 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 (substitute variables based on new path after merge): ```sh $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=<HASH>" -it ogma-verify-83 ``` **Expected result** The command script prints "Success", indicating that no instances of ROS2 are found. **Solution implemented** Rename all instances of ROS2 to ROS 2 in the code, the documentation, and the README. **Further notes** None.
- Loading branch information