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.

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

Docker build script shebang fix and extended usage notes #7793

Merged
merged 2 commits into from
Feb 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions build.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env bash
set -e

if [[ $# == 0 ]]; then
Expand All @@ -6,9 +7,15 @@ Usage syntax: ./build.sh <TARGET>

Notes:
* You can specify multiple targets.
* If no targets are specified, *all* of them will be built.
./build.sh <TARGET_1> <TARGET_2> <TARGET_N>
* To get a list of all targets use \"help\". Hint: pipe the output through a pager.
./build.sh help | less
* To build all targets use \"all\"
./build.sh all
* To clean a target prefix it with \"clean_\".
* To clean all targets just use \"clean\"."
./build.sh clean_MATEKF405SE
* To clean all targets just use \"clean\".
./build.sh clean"
exit 1
fi

Expand Down
6 changes: 6 additions & 0 deletions docs/development/Building in Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ Where `<TARGET>` must be replaced with the name of the target that you want to b
./build.sh MATEKF405SE
```

Run the script with no arguments to get more details on its usage:

```
./build.sh
```

## Windows 10

Docker on Windows requires full paths for mounting volumes in `docker run` commands. For example: `c:\Users\pspyc\Documents\Projects\inav` becomes `//c/Users/pspyc/Documents/Projects/inav` .
Expand Down