Skip to content

Make OpenMANIPULATOR_X workspace paths consistent by using absolute paths #1814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make OpenMANIPULATOR_X workspace paths consistent by using absolute paths #1814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .../platform/openmanipulator_x/quick_start_guide/quickstart_humble_ros_packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ $ sudo apt install \
```

```bash
$ mkdir -p colcon_ws/src
$ mkdir -p ~/colcon_ws/src
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve the robustness of this command, it's a good practice to quote paths that involve shell expansions like ~. This prevents errors if a user's home directory path contains spaces or other special characters.

While this might be an edge case, quoting the path makes the instructions more reliable for all users and is a good defensive practice in shell commands.

Suggested change
$ mkdir -p ~/colcon_ws/src
$ mkdir -p "~/colcon_ws/src"

$ cd ~/colcon_ws/src/
$ git clone -b humble https://github.com/ROBOTIS-GIT/DynamixelSDK.git
$ git clone -b humble https://github.com/ROBOTIS-GIT/open_manipulator.git
Expand Down
2 changes: 1 addition & 1 deletion ...n/platform/openmanipulator_x/quick_start_guide/quickstart_jazzy_ros_packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This will ensure you have the latest and most compatible version for your system
#### Clone the Repository

```bash
$ mkdir -p ros2_ws/src
$ mkdir -p ~/ros2_ws/src
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To make this command more robust, it's best to quote paths that use shell expansions like ~. This will prevent the command from failing if a user's home directory path contains spaces or other special characters. Quoting the path is a good defensive measure that improves the reliability of the documentation for all users.

Suggested change
$ mkdir -p ~/ros2_ws/src
$ mkdir -p "~/ros2_ws/src"

$ cd ~/ros2_ws/src
$ git clone -b jazzy https://github.com/ROBOTIS-GIT/DynamixelSDK.git && \
git clone -b jazzy https://github.com/ROBOTIS-GIT/dynamixel_interfaces.git && \
Expand Down