maple/prplos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

scripts/mkits.sh: improve error handling for required parameters

Browse Source 
Currently the script will exit with usage information and an error if a required
parameter is missing, but it actually doesn't provide any information about which
parameter is missing, so its quite tedious to find out which parameter is missing.

So lets fix it by adding a function to check for missing parameters and printing
a proper error message with the missing parameter(s):

  Error: Missing required parameters:
    CONFIG (-c): config name
  Usage: mkits.sh -A arch -C comp -a addr -e entry -v version -k kernel [-D name -n address -d dtb] -o its_file -c config_name
  ...

While at it, harmonize the shebang with other shell scripts and thus as
well allow usage of more advanced bash features.

Additionally fix the missing usage description of `-c` argument.

Upstream-Status: Submitted [https://github.com/openwrt/openwrt/pull/18524]
Signed-off-by: Petr Štetiar <ynezz@true.cz>
Signed-off-by: Petr Štetiar <petr.stetiar@prplfoundation.org>
This commit is contained in:
Petr Štetiar 2025-04-18 08:40:46 +00:00 committed by Petr Štetiar
parent a822e0a6c2
commit 68210dd0d7
No known key found for this signature in database
GPG Key ID: 58EE120F30CC02D3
1 changed files with 33 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
scripts/mkits.sh
View File

@ -1,4 +1,4 @@
#!/bin/sh
#!/usr/bin/env bash
#
# Licensed under the terms of the GNU GPL License version 2 or later.
#
@ -16,7 +16,7 @@
usage() {
printf "Usage: %s -A arch -C comp -a addr -e entry" "$(basename "$0")"
printf " -v version -k kernel [-D name -n address -d dtb] -o its_file"
printf " -v version -k kernel [-D name -n address -d dtb] -o its_file -c config_name"
printf "\n\t-A ==> set architecture to 'arch'"
printf "\n\t-C ==> set compression type 'comp'"
@ -75,12 +75,38 @@ do
esac
done
# Make sure user entered all required parameters
if [ -z "${ARCH}" ] || [ -z "${COMPRESS}" ] || [ -z "${LOAD_ADDR}" ] || \
[ -z "${ENTRY_ADDR}" ] || [ -z "${VERSION}" ] || [ -z "${KERNEL}" ] || \
[ -z "${OUTPUT}" ] || [ -z "${CONFIG}" ]; then
check_required_params() {
local missing=""
# Array of required parameters in format "variable:flag:description"
local required_params=(
"ARCH:A:architecture"
"COMPRESS:C:compression type"
"LOAD_ADDR:a:load address"
"ENTRY_ADDR:e:entry point"
"VERSION:v:kernel version"
"KERNEL:k:kernel image"
"OUTPUT:o:output file"
"CONFIG:c:config name"
)
for param in "${required_params[@]}"; do
local var_name="${param%%:*}"
local flag="${param#*:}"
local desc="${param##*:}"
flag="${flag%%:*}"
[ -z "${!var_name}" ] && missing="${missing}\n ${var_name} (-${flag}): ${desc}"
done
[ -z "${missing}" ] && return
echo -e "Error: Missing required parameters:${missing}"
usage
fi
}
check_required_params
ARCH_UPPER=$(echo "$ARCH" | tr '[:lower:]' '[:upper:]')