Skip to content

Commit

Permalink
Improving possible confusing instructions (#4124)
Browse files Browse the repository at this point in the history
* Improving possible confusing instructions

The instruction tell the reader to search and replace USERNAME in 2 scripts. But some USERNAME strings should not be replaced.
Changed the string that need to be replaced with YOUR_USERNAME and changed the instructions to match that.

Signed-off-by: Tim <timbosschaerts@gmail.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
(cherry picked from commit fecf496)
  • Loading branch information
tixel authored and mergify[bot] committed Jan 24, 2024
1 parent 71d2de2 commit beeb2d3
Showing 1 changed file with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,11 @@ Therefore add the following to ``.devcontainer/devcontainer.json``:
{
"name": "ROS 2 Development Container",
"privileged": true,
"remoteUser": "USERNAME",
"remoteUser": "YOUR_USERNAME",
"build": {
"dockerfile": "Dockerfile",
"args": {
"USERNAME": "USERNAME"
"USERNAME": "YOUR_USERNAME"
}
},
"workspaceFolder": "/home/ws",
Expand Down Expand Up @@ -155,13 +155,13 @@ Therefore add the following to ``.devcontainer/devcontainer.json``:
"source=${localWorkspaceFolder}/../cache/ROS_DISTRO/install,target=/home/ws/install,type=bind",
"source=${localWorkspaceFolder}/../cache/ROS_DISTRO/log,target=/home/ws/log,type=bind"
],
"postCreateCommand": "sudo rosdep update && sudo rosdep install --from-paths src --ignore-src -y && sudo chown -R USERNAME /home/ws/"
"postCreateCommand": "sudo rosdep update && sudo rosdep install --from-paths src --ignore-src -y && sudo chown -R $(whoami) /home/ws/"
}
Use ``Ctrl+F`` to open the search and replace menu.
Search for ``USERNAME`` and replace it with your ``Linux username``.
Search for ``YOUR_USERNAME`` and replace it with your ``Linux username``.
If you do not know your username, you can find it by running ``echo $USERNAME`` in the terminal.
Also replace ``ROS_DISTRO``, with the ROS 2 distribution that you want to use and added to the cache previously, for example, "humble" or "foxy".

Expand Down Expand Up @@ -201,7 +201,7 @@ Open the Dockerfile and add the following contents:
USER $USERNAME
CMD ["/bin/bash"]
Search here also for the ``USERNAME`` and replace it with your ``Linux username`` and the ``ROS_DISTRO`` with the ROS 2 distribution you wish to use and added to the cache previously.
Search here also for ``ROS_DISTRO`` with the ROS 2 distribution you wish to use and added to the cache previously.


Open and Build Development Container
Expand Down

0 comments on commit beeb2d3

Please sign in to comment.