From b67604f235ec9166ff687488b4f4c66b20b11737 Mon Sep 17 00:00:00 2001 From: Max SCHMELLER Date: Thu, 19 Sep 2024 14:55:29 +0900 Subject: [PATCH 1/3] docs: add apt update/upgrade to workspace install/update instructions Signed-off-by: Max SCHMELLER --- .../autoware/docker-installation.md | 20 ++++++++++++++++--- .../autoware/source-installation.md | 14 +++++++++++++ 2 files changed, 31 insertions(+), 3 deletions(-) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 87bd0c8beab..1e5a6f6799b 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 2e61fb8c986..8a81df21e4b 100644 --- a/docs/installation/autoware/source-installation.md +++ b/docs/installation/autoware/source-installation.md @@ -88,6 +88,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 ``` @@ -135,10 +138,21 @@ 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 ``` From 7db85619bea864afc8b66eb183b5147e0094200c Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 19 Sep 2024 06:09:06 +0000 Subject: [PATCH 2/3] style(pre-commit): autofix --- docs/installation/autoware/source-installation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/installation/autoware/source-installation.md b/docs/installation/autoware/source-installation.md index 8a81df21e4b..f9cc15220ba 100644 --- a/docs/installation/autoware/source-installation.md +++ b/docs/installation/autoware/source-installation.md @@ -141,6 +141,7 @@ sudo apt-get -y install git 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 From 6ff3cf5b995f3e3878501d1fb4165960b31a73b4 Mon Sep 17 00:00:00 2001 From: Max Schmeller <6088931+mojomex@users.noreply.github.com> Date: Sun, 22 Sep 2024 00:59:48 +0900 Subject: [PATCH 3/3] chore: apply suggestions to only remove contents of src, not src itself MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt Signed-off-by: Max SCHMELLER --- docs/installation/autoware/docker-installation.md | 2 +- docs/installation/autoware/source-installation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 1e5a6f6799b..474b5ff714a 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -126,7 +126,7 @@ Inside the container, you can run the Autoware tutorials by following these link > and re-importing all dependencies may be necessary: > > ```bash -> rm -rf src +> rm -rf src/* > vcs import src < autoware.repos > ``` diff --git a/docs/installation/autoware/source-installation.md b/docs/installation/autoware/source-installation.md index f9cc15220ba..bd2998e3b01 100644 --- a/docs/installation/autoware/source-installation.md +++ b/docs/installation/autoware/source-installation.md @@ -143,7 +143,7 @@ sudo apt-get -y install git and re-importing all dependencies may be necessary: ```bash - rm -rf src + rm -rf src/* vcs import src < autoware.repos ```