From 02139faf43b2571180435e709de5784b9060fc4f Mon Sep 17 00:00:00 2001 From: Max Schmeller <6088931+mojomex@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:51:10 +0900 Subject: [PATCH] docs: add apt update/upgrade to workspace install/update instructions (#615) Signed-off-by: Max SCHMELLER --- .../autoware/docker-installation.md | 20 ++++++++++++++++--- .../autoware/source-installation.md | 15 ++++++++++++++ 2 files changed, 32 insertions(+), 3 deletions(-) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 87bd0c8beab..474b5ff714a 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -90,11 +90,12 @@ Inside the container, you can run the Autoware tutorials by following these link 2. Update dependent ROS packages. - The dependency of Autoware may change after the Docker image was created. - In that case, you need to run the following commands to update the dependency. + The dependencies of Autoware may have changed after the Docker image was created. + In that case, you need to run the following commands to update the dependencies. ```bash - sudo apt update + # Make sure all ros-$ROS_DISTRO-* packages are upgraded to their latest version + sudo apt update && sudo apt upgrade rosdep update rosdep install -y --from-paths src --ignore-src --rosdistro $ROS_DISTRO ``` @@ -114,6 +115,19 @@ Inside the container, you can run the Autoware tutorials by following these link > git pull > vcs import src < autoware.repos > vcs pull src +> # Make sure all ros-$ROS_DISTRO-* packages are upgraded to their latest version +> sudo apt update && sudo apt upgrade +> rosdep update +> rosdep install -y --from-paths src --ignore-src --rosdistro $ROS_DISTRO +> ``` +> +> It might be the case that dependencies imported via `vcs import` have been moved/removed. +> VCStool does not currently handle those cases, so if builds fail after `vcs import`, cleaning +> and re-importing all dependencies may be necessary: +> +> ```bash +> rm -rf src/* +> vcs import src < autoware.repos > ``` #### Using VS Code remote containers for development diff --git a/docs/installation/autoware/source-installation.md b/docs/installation/autoware/source-installation.md index 477d03f0915..2c389ab5b24 100644 --- a/docs/installation/autoware/source-installation.md +++ b/docs/installation/autoware/source-installation.md @@ -89,6 +89,9 @@ sudo apt-get -y install git ```bash source /opt/ros/humble/setup.bash + # Make sure all previously installed ros-$ROS_DISTRO-* packages are upgraded to their latest version + sudo apt update && sudo apt upgrade + rosdep update rosdep install -y --from-paths src --ignore-src --rosdistro $ROS_DISTRO ``` @@ -136,10 +139,22 @@ sudo apt-get -y install git For more information, refer to the [official documentation](https://github.com/dirk-thomas/vcstool). + It might be the case that dependencies imported via `vcs import` have been moved/removed. + VCStool does not currently handle those cases, so if builds fail after `vcs import`, cleaning + and re-importing all dependencies may be necessary: + + ```bash + rm -rf src/* + vcs import src < autoware.repos + ``` + 3. Install dependent ROS packages. ```bash source /opt/ros/humble/setup.bash + # Make sure all previously installed ros-$ROS_DISTRO-* packages are upgraded to their latest version + sudo apt update && sudo apt upgrade + rosdep update rosdep install -y --from-paths src --ignore-src --rosdistro $ROS_DISTRO ```