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

docs(installation): add troubleshooting link to installation #229

Merged
merged 3 commits into from
Oct 28, 2022
Merged

docs(installation): add troubleshooting link to installation #229

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
d70a1ec
Fix the bad link in markdown.
evshary Oct 28, 2022
413df09
Add a link to Troubleshooting for colcon build.
evshary Oct 28, 2022
5390070
Limit the job number to solve build error.
evshary Oct 28, 2022
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
2 changes: 1 addition & 1 deletion docs/design/autoware-interfaces/components/control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ TODO This represents the reported physical efforts exerted by the vehicle actuat

A motion signal to drive the vehicle, achieved by the low-level controller in the vehicle layer. Used by the Vehicle Interface.

- [autoware_auto_control_msgs/AckermannControlCommand](<https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/blob/master/autoware_auto_control_msgs/msg/AckermannControlCommand.idl>
- [autoware_auto_control_msgs/AckermannControlCommand](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/blob/master/autoware_auto_control_msgs/msg/AckermannControlCommand.idl)
- builtin_interfaces::msg::Time stamp
- [autoware_auto_control_msgs/AckermannLateralCommand](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/blob/master/autoware_auto_control_msgs/msg/AckermannLateralCommand.idl) lateral
- builtin_interfaces::msg::Time stamp
Expand Down
4 changes: 3 additions & 1 deletion docs/installation/autoware/docker-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ You might need to log out and log back to make the current user able to use dock
```bash
sudo apt update
rosdep update
rosdep install --from-paths . --ignore-src --rosdistro $ROS_DISTRO
rosdep install -y --from-paths src --ignore-src --rosdistro $ROS_DISTRO
```

5. Build the workspace.
Expand All @@ -113,6 +113,8 @@ You might need to log out and log back to make the current user able to use dock
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

If there is any build issue, refer to [Troubleshooting](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues).

## How to update a workspace

1. Update the Docker image.
Expand Down
2 changes: 2 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 @@ -100,6 +100,8 @@ If you've manually installed the dependencies, you can skip this section.
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

If there is any build issue, refer to [Troubleshooting](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues).

## How to update a workspace

1. Update the `.repos` file.
Expand Down
9 changes: 9 additions & 0 deletions docs/support/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,15 @@ free -h

For more detailed configuration steps, along with an explanation of swap, refer to Digital Ocean's ["How To Add Swap Space on Ubuntu 20.04" tutorial](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-20-04)

If there are too many CPU cores (more than 64) in your machine, it might requires larger memory.
A workaround here is to limit the job number while building.

```bash
MAKEFLAGS="-j4" colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

You can adjust `-j4` to any number based on your system.

### Errors when using the latest version of Autoware

If you are working with the latest version of Autoware, issues can occur due to out-of-date software or old build files.
Expand Down