mirror of
https://codeberg.org/libreboot/lbmk.git
synced 2026-03-25 13:29:03 +02:00
6ebab10caa
in shell scripts, a function named the same as a program included in the $PATH will override that program. for example, you could make a function called ls() and this would override the standand "ls". in lbmk, a part of it was first trying to run the "fail" command, deferring to "err", because some scripts call fail() which does some minor cleanup before calling err. in most cases, fail() is not defined, and it's possible that the user could have a program called "fail" in their $PATH, the behaviour of which we could not determine, and it could have disastrous effects. lbmk error handling has been re-engineered in such a way that the err function is defined in a variable, which defaults to err_ which calls err_, so defined under include/err.sh. in functions that require cleanup prior to error handling, a fail() function is still defined, and err is overridden, thus: err="fail" this change has made xx_() obsolete, so now only x_ is used. the x_ function is a wrapper that can be used to run a command and exit with non-zero status (from lbmk) if the command fails. the xx_ command did the same thing, but called fail() which would have called err(); now everything is $err example: rm -f "$filename" || err "could not delete file" this would now be: rm -f "$filename" || $err "could not delete file" overriding of err= must be done *after* including err.sh. for example: err="fail" . "include/err.sh" ^ this is wrong. instead, one must do: . "include/err.sh" err="fail" this is because err is set as a global variable under err.sh the new error handling is much cleaner, and safer. it also reduces the chance of mistakes such as: calling err when you meant to call fail. this is because the standard way is now to call $err, so you set err="fail" at the top of the script and all is well. Signed-off-by: Leah Rowe <leah@libreboot.org>
152 lines
3.5 KiB
Bash
Executable File
152 lines
3.5 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
# SPDX-FileCopyrightText: 2014,2015,2020,2021,2023 Leah Rowe <leah@libreboot.org>
|
|
# SPDX-FileCopyrightText: 2015 Patrick "P. J." McDermott <pj@pehjota.net>
|
|
# SPDX-FileCopyrightText: 2015, 2016 Klemens Nanni <contact@autoboot.org>
|
|
# SPDX-FileCopyrightText: 2022, Caleb La Grange <thonkpeasant@protonmail.com>
|
|
|
|
set -u -e
|
|
|
|
export LC_COLLATE=C
|
|
export LC_ALL=C
|
|
|
|
. "include/err.sh"
|
|
. "include/option.sh"
|
|
|
|
eval "$(setvars "" option aur_notice tmpdir)"
|
|
err="fail"
|
|
|
|
tmpdir_was_set="y"
|
|
set | grep TMPDIR 1>/dev/null 2>/dev/null || tmpdir_was_set="n"
|
|
if [ "${tmpdir_was_set}" = "y" ]; then
|
|
[ "${TMPDIR%_*}" = "/tmp/lbmk" ] || tmpdir_was_set="n"
|
|
fi
|
|
if [ "${tmpdir_was_set}" = "n" ]; then
|
|
export TMPDIR="/tmp"
|
|
tmpdir="$(mktemp -d -t lbmk_XXXXXXXX)"
|
|
export TMPDIR="${tmpdir}"
|
|
else
|
|
export TMPDIR="${TMPDIR}"
|
|
tmpdir="${TMPDIR}"
|
|
fi
|
|
|
|
linkpath="${0}"
|
|
linkname="${linkpath##*/}"
|
|
buildpath="./script/${linkname}"
|
|
|
|
main()
|
|
{
|
|
x_ id -u 1>/dev/null 2>/dev/null
|
|
[ $# -lt 1 ] && $err "Too few arguments. Try: ${0} help"
|
|
|
|
[ "$1" = "dependencies" ] && x_ install_packages $@ && lbmk_exit 0
|
|
|
|
for cmd in initcmd check_git check_project git_init excmd; do
|
|
eval "${cmd} \$@"
|
|
done
|
|
lbmk_exit 0
|
|
}
|
|
|
|
initcmd()
|
|
{
|
|
[ "$(id -u)" != "0" ] || $err "this command as root is not permitted"
|
|
|
|
check_project
|
|
|
|
case "${1}" in
|
|
help) usage ${0} ;;
|
|
list) items "${buildpath}" ;;
|
|
version) mkversion ;;
|
|
*)
|
|
option="${1}"
|
|
return 0 ;;
|
|
esac
|
|
lbmk_exit 0
|
|
}
|
|
|
|
install_packages()
|
|
{
|
|
if [ $# -lt 2 ]; then
|
|
printf "You must specify a distro, namely:\n" 1>&2
|
|
printf "Look at files under config/dependencies/\n" 1>&2
|
|
printf "Example: ./build dependencies debian\n" 1>&2
|
|
$err "install_packages: target not specified"
|
|
fi
|
|
|
|
[ -f "config/dependencies/${2}" ] || $err "Unsupported target"
|
|
|
|
. "config/dependencies/${2}"
|
|
|
|
x_ ${pkg_add} ${pkglist}
|
|
[ -z "${aur_notice}" ] && return 0
|
|
printf "You must install AUR packages: %s\n" "$aur_notice" 1>&2
|
|
}
|
|
|
|
# release archives contain .gitignore, but not .git.
|
|
# lbmk can be run from lbmk.git, or an archive.
|
|
git_init()
|
|
{
|
|
[ -L ".git" ] && $err "Reference .git is a symlink"
|
|
[ -e ".git" ] && return 0
|
|
eval "$(setvars "$(date -Rd @${versiondate})" cdate _nogit)"
|
|
|
|
git init || $err "${PWD}: cannot initialise Git repository"
|
|
git add -A . || $err "${PWD}: cannot add files to Git repository"
|
|
git commit -m "${projectname} ${version}" --date "${cdate}" \
|
|
--author="lbmk <lbmk@libreboot.org>" || \
|
|
$err "$PWD: can't commit ${projectname}/${version}, date $cdate"
|
|
git tag -a "${version}" -m "${projectname} ${version}" || \
|
|
$err "${PWD}: cannot git-tag ${projectname}/${version}"
|
|
}
|
|
|
|
excmd()
|
|
{
|
|
lbmkcmd="${buildpath}/${option}"
|
|
[ -f "${lbmkcmd}" ] || $err "Invalid command. Run: ${linkpath} help"
|
|
shift 1; "$lbmkcmd" $@ || $err "excmd: ${lbmkcmd} ${@}"
|
|
}
|
|
|
|
usage()
|
|
{
|
|
progname=${0}
|
|
cat <<- EOF
|
|
$(mkversion)
|
|
|
|
USAGE: ${progname} <OPTION>
|
|
|
|
possible values for 'OPTION':
|
|
$(items "${buildpath}")
|
|
|
|
To know what ${projectname} version you're on, type:
|
|
${progname} version
|
|
|
|
Refer to ${projectname} documentation for more info.
|
|
EOF
|
|
}
|
|
|
|
mkversion()
|
|
{
|
|
printf "revision: %s %s\n" "$projectname" "$version"
|
|
printf "revision date: %s\n" "$(date -Rud @${versiondate})"
|
|
}
|
|
|
|
lbmk_exit()
|
|
{
|
|
tmp_cleanup || err_ "lbmk_exit: can't rm tmpdir upon exit $1: $tmpdir"
|
|
exit $1
|
|
}
|
|
|
|
fail()
|
|
{
|
|
tmp_cleanup || printf "WARNING: can't rm tmpdir: %s\n" "$tmpdir" 1>&2
|
|
err_ "${1}"
|
|
}
|
|
|
|
tmp_cleanup()
|
|
{
|
|
[ "${tmpdir_was_set}" = "n" ] || return 0
|
|
rm -Rf "${tmpdir}" || return 1
|
|
}
|
|
|
|
main $@
|