Skip to content

Commit

Permalink
docs: add apt update/upgrade to workspace install/update instructions (
Browse files Browse the repository at this point in the history
…autowarefoundation#615)

Signed-off-by: Max SCHMELLER <[email protected]>
  • Loading branch information
mojomex authored Sep 23, 2024
1 parent 203e78a commit 02139fa
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/installation/autoware/docker-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
Expand Down
15 changes: 15 additions & 0 deletions docs/installation/autoware/source-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```

Expand Down

0 comments on commit 02139fa

Please sign in to comment.