[coreboot-gerrit] [M] Change in coreboot[master]: util/genbuild: Fix style & shellcheck issues

[Felix Held (Code Review)]

Felix Held has submitted this change. ( https://review.coreboot.org/c/coreboot/+/70056 )

Change subject: util/genbuild: Fix style & shellcheck issues
......................................................................

util/genbuild: Fix style & shellcheck issues

There shouldn't be any change to functionality here - this should be
strictly cleanup.
- STYLE: Put variables inside braces.
- SHELLCHECK: Instead of 'var= ' to clear a variable, use 'var=""'
- SHELLCHECK: Put commands and command variables inside quotes.
- SHELLCHECK: Don't use variables inside the printf commands.
- OTHER: COREBOOT_BUILD needed a date format when the variables in the
our_date() function were put into quotes.  This format matches the
output of 'LANG="" LC_ALL=C TZ=UTC0 date'

Signed-off-by: Martin Roth 
Change-Id: I3303caee5c7a53c9df579e6f48d2c3d075a8c278
Reviewed-on: https://review.coreboot.org/c/coreboot/+/70056
Tested-by: build bot (Jenkins) 
Reviewed-by: Jakub Czapiga 
---
M util/genbuild_h/genbuild_h.sh
1 file changed, 44 insertions(+), 21 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Jakub Czapiga: Looks good to me, approved

diff --git a/util/genbuild_h/genbuild_h.sh b/util/genbuild_h/genbuild_h.sh
index 78b09a6..9245e8d 100755
--- a/util/genbuild_h/genbuild_h.sh
+++ b/util/genbuild_h/genbuild_h.sh
@@ -16,15 +16,15 @@

XCOMPILE=$1

-if [ -z "$XCOMPILE" ] || [ "$1" = "--help" ]; then
+if [ -z "${XCOMPILE}" ] || [ "$1" = "--help" ]; then
    echo "usage: $0 <xcompile>" >&2
    exit 1
 fi

# $1: format string
 get_git_head_data() {
-	LANG= git log --no-show-signature -1 --format="format:$1" 2>/dev/null || \
-	LANG= git log -1 --format="format:$1"
+	LANG="" git log --no-show-signature -1 --format="format:$1" 2>/dev/null || \
+	LANG="" git log -1 --format="format:$1"
 }

if [ "${BUILD_TIMELESS}" = "1" ]; then
@@ -32,9 +32,9 @@
    TIMESOURCE="fixed"
    DATE=0
 elif [ "$(git rev-parse --is-inside-work-tree 2>/dev/null)" = "true" ]; then
-	GITREV=$(get_git_head_data %h)
+	GITREV="$(get_git_head_data %h)"
    TIMESOURCE=git
-	DATE=$(get_git_head_data %ct)
+	DATE="$(get_git_head_data %ct)"
    VERSION="$(git describe)"
    MAJOR_VER="$(echo "${VERSION}" | sed 's/([0-9]).([0-9][0-9]*).*/\1/')"
    MINOR_VER="$(echo "${VERSION}" | sed 's/([0-9]).([0-9][0-9]*).*/\2/')"
@@ -51,10 +51,10 @@
 our_date() {
 case $(uname) in
 NetBSD|OpenBSD|DragonFly|FreeBSD|Darwin)
-	date -r $1 $2
+	date -r "$1" "$2"
    ;;
 *)
-	date -d @$1 $2
+	date -d "@$1" "$2"
 esac
 }

@@ -62,7 +62,7 @@
 # xcompile isn't available on the first build.
 # If neither of those gives a valid iasl, check the path.
 IASL="${XGCCPATH}iasl"
-eval $(grep ^IASL:= "$XCOMPILE" 2>/dev/null | sed s,:=,=,)
+eval "$(grep ^IASL:= "${XCOMPILE}" 2>/dev/null | sed s,:=,=,)"
 if [ ! -x "${IASL}" ]; then
    IASL=$(command -v iasl)
 fi
@@ -72,24 +72,24 @@
 printf "/* build system definitions (autogenerated) */\n"
 printf "#ifndef __BUILD_H\n"
 printf "#define __BUILD_H\n\n"
-printf "#define COREBOOT_VERSION %s\n" ""$KERNELVERSION""
+printf "#define COREBOOT_VERSION %s\n" ""${KERNELVERSION}""

#See if the build is running in a git repo and the git command is available
-printf "/* timesource: $TIMESOURCE */\n"
-printf "#define COREBOOT_VERSION_TIMESTAMP $DATE\n"
-printf "#define COREBOOT_ORIGIN_GIT_REVISION "$GITREV"\n"
+printf "/* timesource: %s */\n" "${TIMESOURCE}"
+printf "#define COREBOOT_VERSION_TIMESTAMP %s\n" "${DATE}"
+printf "#define COREBOOT_ORIGIN_GIT_REVISION "%s"\n" "${GITREV}"

-printf "#define COREBOOT_EXTRA_VERSION "%s"\n" "$COREBOOT_EXTRA_VERSION"
+printf "#define COREBOOT_EXTRA_VERSION "%s"\n" "${COREBOOT_EXTRA_VERSION}"
 printf "#define COREBOOT_MAJOR_VERSION %d\n" "${MAJOR_VER}"
 printf "#define COREBOOT_MINOR_VERSION %d\n" "${MINOR_VER}"
-printf "#define COREBOOT_BUILD "$(our_date "$DATE")"\n"
-printf "#define COREBOOT_BUILD_YEAR_BCD 0x$(our_date "$DATE" +%y)\n"
-printf "#define COREBOOT_BUILD_MONTH_BCD 0x$(our_date "$DATE" +%m)\n"
-printf "#define COREBOOT_BUILD_DAY_BCD 0x$(our_date "$DATE" +%d)\n"
-printf "#define COREBOOT_BUILD_WEEKDAY_BCD 0x$(our_date "$DATE" +%w)\n"
-printf "#define COREBOOT_BUILD_EPOCH "$(our_date "$DATE" +%s)"\n"
-printf "#define COREBOOT_DMI_DATE "$(our_date "$DATE" +%m/%d/%Y)"\n"
+printf "#define COREBOOT_BUILD "%s"\n" "$(our_date "${DATE}" "+%a %b %d %H:%M:%S %Z %Y")"
+printf "#define COREBOOT_BUILD_YEAR_BCD 0x%d\n" "$(our_date "${DATE}" "+%y")"
+printf "#define COREBOOT_BUILD_MONTH_BCD 0x%d\n" "$(our_date "${DATE}" "+%m")"
+printf "#define COREBOOT_BUILD_DAY_BCD 0x%d\n" "$(our_date "${DATE}" "+%d")"
+printf "#define COREBOOT_BUILD_WEEKDAY_BCD 0x%d\n" "$(our_date "${DATE}" "+%w")"
+printf "#define COREBOOT_BUILD_EPOCH "%d"\n" "$(our_date "${DATE}" "+%s")"
+printf "#define COREBOOT_DMI_DATE "%s"\n" "$(our_date "${DATE}" "+%m/%d/%Y")"
 printf "\n"
-printf "#define COREBOOT_COMPILE_TIME "$(our_date "$DATE" +%T)"\n"
+printf "#define COREBOOT_COMPILE_TIME "%s"\n" "$(our_date "${DATE}" "+%T")"
 printf "#define ASL_VERSION 0x%d\n" "${IASLVERSION}"
 printf "#endif\n"