Skip to content
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

Jump to bottom

docs: add apt update/upgrade to workspace install/update instructions #615

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+32 −3
Open

docs: add apt update/upgrade to workspace install/update instructions #615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b67604f
docs: add apt update/upgrade to workspace install/update instructions
mojomex Sep 19, 2024
7db8561
style(pre-commit): autofix
pre-commit-ci[bot] Sep 19, 2024
6ff3cf5
chore: apply suggestions to only remove contents of src, not src itself
mojomex Sep 21, 2024
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
20 changes: 17 additions & 3 deletions docs/installation/autoware/docker-installation.md
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -135,10 +138,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
Loading