build.sh: require board argument, print list of targets

This commit updates the build.sh script to require a board argument, and
print a list of available targets when no argument is given. The script
also updates the README.md file to document this change.

Signed-off-by: Luca Burelli <[email protected]>

Author: pillo79

README.md

@@ -126,19 +126,24 @@ Download and install the Zephyr SDK for your OS from [here](https://github.com/z
 
 ### Build the Loader
 
-To build the loader, run the following commands:
+The loader is compiled for each board by running the `./extra/build.sh` script.
+The target can be specified either with the Arduino board name (as defined in
+boards.txt), or with the Zephyr board name and any additional arguments that
+may be required by the Zephyr build system.
+
+For example, to build for the Arduino Portenta H7, you can run either:
 ```bash
-export ZEPHYR_SDK_INSTALL_DIR=$folder_where_you_installed_the_sdk
-./extra/build.sh $zephyr_board_name $arduino_variant_board_name
+./extra/build.sh portentah7
 ```
-Replace `$zephyr_board_name` and `$arduino_variant_board_name` with the appropriate names for your board.
 
-Example for Arduino Portenta H7:
+or:
+
 ```bash
-./extra/build.sh arduino_portenta_h7//m7 arduino_portenta_h7
+./extra/build.sh arduino_portenta_h7//m7
 ```
 
-The firmwares will be copied to [firmwares](/firmwares) folder.
+The firmwares will be copied to [firmwares](/firmwares) folder, and the
+associated variant will be updated.
 
 ### Flash the Loader
 

extra/build.sh

@@ -8,24 +8,43 @@ if [ x$ZEPHYR_SDK_INSTALL_DIR == x"" ]; then
 		echo "ZEPHYR_SDK_INSTALL_DIR not set and no SDK found"
 		exit 1
 	fi
-	echo "ZEPHYR_SDK_INSTALL_DIR not set, using $SDK_PATH"
 	export ZEPHYR_SDK_INSTALL_DIR=${SDK_PATH}
 fi
 
-if [[ $# -eq 0 ]]; then
-	first_board=$(extra/get_board_details.sh | jq -cr '.[0]')
-	target=$(jq -cr '.target' <<< "$first_board")
-	args=$(jq -cr '.args' <<< "$first_board")
+if [ $# -eq 0 ] || [ x$1 == x"-h" ] || [ x$1 == x"--help" ]; then
+	cat << EOF
+Usage:
+	$0 <arduino_board>
+	$0 <zephyr_board> [<west_args>]
+Build the loader for the given target.
+
+When given an <arduino_board> defined in 'boards.txt' (e.g. 'giga'), the actual
+Zephyr board target and arguments are taken from that definition.
+
+When given a <zephyr_board>, it is passed as the '-b' argument to 'west build'.
+Additional <west_args> are passed as-is at the end of the command line.
+
+Available targets, as defined in 'boards.txt':
+
+EOF
+	extra/get_board_details.sh |
+		jq -r 'sort_by(.variant) | .[] | "\t\(.board)\t\(.target) \(.args)"' |
+		column -ts$'\t'
+	echo
+	exit 0
+fi
+
+# try to find the board in boards.txt
+chosen_board=$(extra/get_board_details.sh | jq -cr ".[] | select(.board == \"$1\") // empty")
+if ! [ -z "$chosen_board" ]; then
+	# found, use the target and args from there
+	target=$(jq -cr '.target' <<< "$chosen_board")
+	args=$(jq -cr '.args' <<< "$chosen_board")
 else
+	# expect Zephyr-compatible target and args
 	target=$1
-	chosen_board=$(extra/get_board_details.sh | jq -cr ".[] | select(.board == \"$target\") // empty")
-	if ! [ -z "$chosen_board" ]; then
-		target=$(jq -cr '.target' <<< "$chosen_board")
-		args=$(jq -cr '.args' <<< "$chosen_board")
-	else
-		shift
-		args="$*"
-	fi
+	shift
+	args="$*"
 fi
 
 echo