From 58806a2bd638960367f0d339f936518533d9655a Mon Sep 17 00:00:00 2001 From: Krasiyan Nedelchev Date: Tue, 1 Feb 2022 01:27:16 +0100 Subject: [PATCH] extend the build.sh script usage notes; add reference in the dev "Building in Docker.md" --- build.sh | 10 ++++++++-- docs/development/Building in Docker.md | 6 ++++++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/build.sh b/build.sh index da4b69dc2..58db51aa4 100755 --- a/build.sh +++ b/build.sh @@ -7,9 +7,15 @@ Usage syntax: ./build.sh Notes: * You can specify multiple targets. - * If no targets are specified, *all* of them will be built. + ./build.sh + * 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 diff --git a/docs/development/Building in Docker.md b/docs/development/Building in Docker.md index 99a8784e6..eafb9b5e6 100755 --- a/docs/development/Building in Docker.md +++ b/docs/development/Building in Docker.md @@ -20,6 +20,12 @@ Where `` 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` .