2023-10-26 19:11:40 +00:00
|
|
|
#!/usr/bin/env sh
|
|
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
2024-05-26 00:54:36 +00:00
|
|
|
# Copyright (c) 2014-2015,2020-2024 Leah Rowe <leah@libreboot.org>
|
|
|
|
# Copyright (c) 2015 Patrick "P. J." McDermott <pj@pehjota.net>
|
|
|
|
# Copyright (c) 2015-2016 Klemens Nanni <contact@autoboot.org>
|
|
|
|
# Copyright (c) 2022 Caleb La Grange <thonkpeasant@protonmail.com>
|
2023-10-26 19:11:40 +00:00
|
|
|
|
|
|
|
set -u -e
|
|
|
|
|
2024-05-09 13:48:14 +00:00
|
|
|
if [ "./${0##*/}" != "${0}" ] || [ ! -f "build" ] || [ -L "build" ]; then
|
2024-05-16 02:59:23 +00:00
|
|
|
printf "You must run this in the proper work directory.\n" 1>&2
|
2024-05-09 13:31:43 +00:00
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
2024-05-26 11:10:27 +00:00
|
|
|
. "include/lib.sh"
|
2023-10-26 19:11:40 +00:00
|
|
|
|
2024-06-05 10:07:53 +00:00
|
|
|
eval "$(setvars "" vdir src_dirname srcdir _xm mode xp)"
|
safer, simpler error handling in cbmk
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 cbmk, 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.
cbmk 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 cbmk) 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 <info@minifree.org>
2024-03-27 01:19:39 +00:00
|
|
|
err="fail"
|
2023-10-26 19:11:40 +00:00
|
|
|
|
|
|
|
linkpath="${0}"
|
|
|
|
linkname="${linkpath##*/}"
|
|
|
|
|
|
|
|
main()
|
|
|
|
{
|
2024-06-02 23:17:36 +00:00
|
|
|
[ $# -lt 1 ] && badcmd
|
2024-05-16 10:23:22 +00:00
|
|
|
spath="script/$1"
|
2023-10-26 19:11:40 +00:00
|
|
|
|
2024-05-25 15:34:07 +00:00
|
|
|
for g in "which git" "git config --global user.name" \
|
|
|
|
"git config --global user.email" "git_init"; do
|
|
|
|
eval "$g 1>/dev/null 2>/dev/null || git_err \"$g\""
|
|
|
|
done
|
2024-05-15 03:02:48 +00:00
|
|
|
|
2023-10-26 19:11:40 +00:00
|
|
|
case "${1}" in
|
2024-06-02 22:34:10 +00:00
|
|
|
version) printf "%s\nWebsite: %s\n" "$relname" "$projectsite" ;;
|
2024-05-11 02:52:52 +00:00
|
|
|
release) shift 1; mkrelease $@ ;;
|
2024-05-16 10:34:31 +00:00
|
|
|
*)
|
2024-06-02 23:17:36 +00:00
|
|
|
[ -f "$spath" ] || badcmd
|
2024-05-26 00:54:36 +00:00
|
|
|
shift 1; "$spath" $@ || $err "excmd: $spath $@" ;;
|
2023-10-26 19:11:40 +00:00
|
|
|
esac
|
|
|
|
}
|
|
|
|
|
|
|
|
git_init()
|
|
|
|
{
|
2024-05-25 15:56:44 +00:00
|
|
|
[ -L ".git" ] && return 1
|
2023-10-26 19:11:40 +00:00
|
|
|
[ -e ".git" ] && return 0
|
2024-05-26 00:54:36 +00:00
|
|
|
eval "$(setvars "$(date -Rud @$versiondate)" cdate _nogit)"
|
2023-10-26 19:11:40 +00:00
|
|
|
|
2024-05-25 15:56:44 +00:00
|
|
|
git init || return 1
|
|
|
|
git add -A . || return 1
|
2024-05-26 00:54:36 +00:00
|
|
|
git commit -m "$projectname $version" --date "$cdate" \
|
2024-05-25 15:56:44 +00:00
|
|
|
--author="xbmk <xbmk@example.com>" || return 1
|
2024-05-26 00:54:36 +00:00
|
|
|
git tag -a "$version" -m "$projectname $version" || return 1
|
2023-10-26 19:11:40 +00:00
|
|
|
}
|
|
|
|
|
2024-05-11 02:52:52 +00:00
|
|
|
mkrelease()
|
|
|
|
{
|
2024-05-16 02:59:23 +00:00
|
|
|
export XBMK_RELEASE="y"
|
2024-05-11 02:52:52 +00:00
|
|
|
|
|
|
|
vdir="release"
|
|
|
|
while getopts d:m: option; do
|
2024-06-02 23:17:36 +00:00
|
|
|
[ -z "$OPTARG" ] && badcmd "empty argument not allowed"
|
2024-05-26 00:54:36 +00:00
|
|
|
case "$option" in
|
|
|
|
d) vdir="$OPTARG" ;;
|
|
|
|
m) mode="$OPTARG" ;;
|
2024-06-02 23:17:36 +00:00
|
|
|
*) badcmd "invalid option '-$option'" ;;
|
2024-05-11 02:52:52 +00:00
|
|
|
esac
|
|
|
|
done
|
|
|
|
|
2024-05-26 00:54:36 +00:00
|
|
|
vdir="$vdir/$version"
|
2024-05-11 02:52:52 +00:00
|
|
|
src_dirname="${relname}_src"
|
2024-05-26 00:54:36 +00:00
|
|
|
srcdir="$vdir/$src_dirname"
|
2024-05-11 02:52:52 +00:00
|
|
|
|
2024-05-26 00:54:36 +00:00
|
|
|
[ -e "$vdir" ] && $err "already exists: \"$vdir\""
|
|
|
|
mkdir -p "$vdir" || $err "mkvdir: !mkdir -p \"$vdir\""
|
|
|
|
git clone . "$srcdir" || $err "mkdir: !gitclone \"$srcdir\""
|
2024-06-09 14:47:51 +00:00
|
|
|
touch "$srcdir/lock" || $err "can't make lock file in $srcdir/"
|
2024-05-11 02:52:52 +00:00
|
|
|
|
|
|
|
build_release
|
|
|
|
|
2024-05-26 00:54:36 +00:00
|
|
|
printf "\n\nDONE! Check release files under %s\n" "$vdir"
|
2024-05-11 02:52:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
build_release()
|
|
|
|
{
|
2024-05-26 00:54:36 +00:00
|
|
|
_xm="build_release $vdir"
|
2024-05-11 02:52:52 +00:00
|
|
|
(
|
2024-05-26 00:54:36 +00:00
|
|
|
cd "$srcdir" || $err "$_xm: !cd \"$srcdir\""
|
2024-05-11 02:52:52 +00:00
|
|
|
fetch_trees
|
2024-05-15 02:19:32 +00:00
|
|
|
x_ mv src/docs docs
|
2024-05-11 02:52:52 +00:00
|
|
|
) || $err "can't create release files"
|
|
|
|
|
|
|
|
git log --graph --pretty=format:'%Cred%h%Creset %s %Creset' \
|
2024-05-26 00:54:36 +00:00
|
|
|
--abbrev-commit > "$srcdir/CHANGELOG" || $err "!gitlog $srcdir"
|
2024-06-09 14:47:51 +00:00
|
|
|
rm -f "$srcdir/lock" || $err "can't remove lock file in $srcdir"
|
2024-05-11 02:52:52 +00:00
|
|
|
|
|
|
|
(
|
2024-05-26 00:54:36 +00:00
|
|
|
cd "${srcdir%/*}" || $err "$_xm: mktarball \"$srcdir\""
|
2024-05-19 07:14:57 +00:00
|
|
|
mktarball "${srcdir##*/}" "${srcdir##*/}.tar.xz" || $err "$_xm: mksrc"
|
2024-05-11 02:52:52 +00:00
|
|
|
) || $err "can't create src tarball"
|
2024-05-26 00:54:36 +00:00
|
|
|
[ "$mode" = "src" ] && return 0
|
2024-05-11 02:52:52 +00:00
|
|
|
|
2024-06-09 14:47:51 +00:00
|
|
|
touch "$srcdir/lock" || $err "can't make lock file in $srcdir/"
|
|
|
|
|
2024-05-11 02:52:52 +00:00
|
|
|
(
|
2024-05-26 00:54:36 +00:00
|
|
|
cd "$srcdir" || $err "$_xm: 2 !cd \"$srcdir\""
|
|
|
|
./build roms all || $err "$_xm: roms-all"
|
|
|
|
./build roms serprog rp2040 || $err "$_xm: rp2040"
|
|
|
|
./build roms serprog stm32 || $err "$_xm: stm32"
|
2024-05-15 00:41:19 +00:00
|
|
|
x_ mv bin ../roms
|
2024-05-11 02:52:52 +00:00
|
|
|
) || $err "can't build rom images"
|
|
|
|
|
2024-05-26 00:54:36 +00:00
|
|
|
rm -Rf "$srcdir" || $err "!rm -Rf $srcdir"
|
2024-05-11 02:52:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
fetch_trees()
|
|
|
|
{
|
2024-05-15 02:39:28 +00:00
|
|
|
for x in $(items config/git); do
|
|
|
|
./update trees -f "$x" || $err "$_xm: fetch $x"
|
2024-06-06 00:01:22 +00:00
|
|
|
singletree "$x" || x_ rm -Rf "src/$x/$x"
|
2024-05-11 02:52:52 +00:00
|
|
|
done
|
git.sh: Remove .git if XBMK_RELEASE=y
The build system already deletes .git in all source
directories for each given release, but does so at
the very end; it still does, but now it is deleted
one by one per project, to save space during very
large builds (release sizes vary wildly, depending
on how many trees exist for coreboot basically).
If you're building entirely in tmpfs (as I do), this
could be a problem if you have lots of .git/ directories.
This change reduces disk usage, or in the above example,
memory usage when running the build system from tmpfs.
This complements another recent change, where ROM images
are compressed per target during release builds, rather
than all at the very end of the process. It is part of a
series of optimisations, to reduce the memory and disk
usage of the build system, and to reduce I/O wastage
in general.
This change will not be the last of such changes!
Signed-off-by: Leah Rowe <leah@libreboot.org>
2024-05-18 03:53:31 +00:00
|
|
|
rmgit .
|
2024-05-11 02:52:52 +00:00
|
|
|
}
|
|
|
|
|
2023-10-26 19:11:40 +00:00
|
|
|
fail()
|
|
|
|
{
|
2024-06-09 17:48:58 +00:00
|
|
|
tmp_cleanup || printf "WARNING: can't rm tmpfiles: %s\n" "$tmpdir" 1>&2
|
safer, simpler error handling in cbmk
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 cbmk, 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.
cbmk 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 cbmk) 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 <info@minifree.org>
2024-03-27 01:19:39 +00:00
|
|
|
err_ "${1}"
|
2023-10-26 19:11:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
tmp_cleanup()
|
|
|
|
{
|
2024-05-26 00:54:36 +00:00
|
|
|
[ "$tmpdir_was_set" = "n" ] || return 0
|
|
|
|
rm -Rf "$tmpdir" || return 1
|
2024-06-09 14:37:13 +00:00
|
|
|
rm -f lock || return 1
|
2023-10-26 19:11:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
main $@
|
2024-05-19 07:14:57 +00:00
|
|
|
tmp_cleanup || err_ "can't rm tmpdir upon non-zero exit: $tmpdir"
|