2023-10-26 19:11:40 +00:00
|
|
|
#!/usr/bin/env sh
|
|
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
2024-05-11 02:52:52 +00:00
|
|
|
# SPDX-FileCopyrightText: 2014,2015,2020-2024 Leah Rowe <leah@libreboot.org>
|
2023-10-26 19:11:40 +00:00
|
|
|
# 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
|
|
|
|
|
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
|
|
|
|
|
2023-10-26 19:11:40 +00:00
|
|
|
. "include/option.sh"
|
|
|
|
|
2024-05-16 10:11:25 +00:00
|
|
|
eval "$(setvars "" aur_notice 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()
|
|
|
|
{
|
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
|
|
|
x_ id -u 1>/dev/null 2>/dev/null
|
2024-05-15 03:30:42 +00:00
|
|
|
[ $# -lt 1 ] && $err "Check $projectname documentation for help."
|
2024-05-16 10:23:22 +00:00
|
|
|
spath="script/$1"
|
2023-10-26 19:11:40 +00:00
|
|
|
|
2024-05-19 07:14:57 +00:00
|
|
|
[ "$1" = "dependencies" ] && x_ install_packages $@ && return 0
|
2023-10-26 19:11:40 +00:00
|
|
|
|
2024-05-25 15:34:48 +00:00
|
|
|
[ "$(id -u)" != "0" ] || $err "this command as root is not permitted"
|
|
|
|
|
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-05-15 01:49:30 +00:00
|
|
|
version) printf "%s\n" "$relname" ;;
|
2024-05-11 02:52:52 +00:00
|
|
|
release) shift 1; mkrelease $@ ;;
|
2024-05-16 10:34:31 +00:00
|
|
|
*)
|
|
|
|
[ -f "${spath}" ] || $err "Bad command. Check docs."
|
|
|
|
shift 1; "$spath" $@ || $err "excmd: ${spath} ${@}" ;;
|
2023-10-26 19:11:40 +00:00
|
|
|
esac
|
|
|
|
}
|
|
|
|
|
|
|
|
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
|
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 "install_packages: target not specified"
|
2023-10-26 19:11:40 +00:00
|
|
|
fi
|
|
|
|
|
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
|
|
|
[ -f "config/dependencies/${2}" ] || $err "Unsupported target"
|
2023-10-26 19:11:40 +00:00
|
|
|
|
|
|
|
. "config/dependencies/${2}"
|
|
|
|
|
2024-05-19 07:14:57 +00:00
|
|
|
x_ $pkg_add $pkglist && [ -n "$aur_notice" ] && \
|
|
|
|
printf "Please install AUR packages: %s\n" "$aur_notice" 1>&2; return 0
|
2023-10-26 19:11:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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-15 02:10:25 +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
|
rebase cbmk 9429287 per lbmk c4d90087..f5b04fa5
cbmk 9429287 is the present canoeboot revision, on this day,
two commits after canoeboot 20231107
the cbmk revision was based on lbmk c4d90087, but lbmk
has developed a lot since, right up to f5b04fa5. lbmk
c4d90087 was four commits after libreboot 20231106
this patch brings cbmk up to date, versus lbmk f5b04fa5,
which is 135 commits after libreboot 20231106 (not 4)
therefore, the next canoeboot release shall import lbmk
changes made *after* lbmk revision f5b04fa5. good day!
In English (the above is for my reference, next time
I make a new canoeboot release):
This imports all of the numerous improvements from
Libreboot, sans the non-FSDG-compliant changes. You
can find a full list of such changes in the audit4 page:
https://libreboot.org/news/audit4.html
A full canoeboot-ised changelog will be available in
the next canoeboot release, with these and subsequent
changes. Most notable here is the update to the new
GRUB 2.12 release (instead of 2.12-rc1), and the
improvements Riku made to pico-serprog. And the build
system improvements from lbmk, such as improved, more
generic cmake and autoconf handling.
Canoeboot-specific changes: I also tweaked the deblob
logic, to make it less error-prone. The new design
changes imported into cbmk (based on latest lbmk) somewhat
broke the deblob logic; it was constantly reminding the
user that blobs.list was missing for coreboot,
at config/coreboot/blobs.list - coreboot is a multi-tree
project in both cbmk and lbmk, and the deblob logic was
tuned for single/multi, but was treating coreboot as both.
for simplicity, i removed the check for whether blobs.list
is present. this means that the operator must ensure that
these files are present, in any given revision, where they
are required on a given set of projects (and the files are
all present, in this update to cbmk)
Also of note: the grub.cfg improvements are included in this
cbmk update. The improved grub.cfg can find grub/syslinux
configs by default, not just grub anymore, also finds extlinux,
and will also find them on EFI System Partition - in addition,
UEFI-based install media is also more robust; although cbmk
doesn't provide UEFI configurations on x86, our GRUB palyoad
does still need to work with distro install media, and many
of them now use UEFI-based GRUB configurations in their
installation media, which just happen to work with our GRUB
Signed-off-by: Leah Rowe <leah@libreboot.org>
2024-01-02 11:37:25 +00:00
|
|
|
git commit -m "${projectname} ${version}" --date "${cdate}" \
|
2024-05-25 15:56:44 +00:00
|
|
|
--author="xbmk <xbmk@example.com>" || return 1
|
|
|
|
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
|
|
|
|
[ -z "${OPTARG}" ] && $err "Empty argument not allowed"
|
|
|
|
case "${option}" in
|
|
|
|
d) vdir="${OPTARG}" ;;
|
|
|
|
m) mode="${OPTARG}" ;;
|
|
|
|
*) $err "Invalid option" ;;
|
|
|
|
esac
|
|
|
|
done
|
|
|
|
|
|
|
|
vdir="${vdir}/${version}"
|
|
|
|
src_dirname="${relname}_src"
|
|
|
|
srcdir="${vdir}/${src_dirname}"
|
|
|
|
|
|
|
|
[ -e "${vdir}" ] && $err "already exists: \"${vdir}\""
|
2024-05-14 23:42:27 +00:00
|
|
|
mkdir -p "${vdir}" || $err "mkvdir: !mkdir -p \"${vdir}\""
|
|
|
|
git clone . "${srcdir}" || $err "mkdir: !gitclone \"${srcdir}\""
|
2024-05-11 02:52:52 +00:00
|
|
|
|
|
|
|
build_release
|
|
|
|
|
2024-05-11 21:14:04 +00:00
|
|
|
printf "\n\nDONE! Check release files under %s\n" "${vdir}"
|
2024-05-11 02:52:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
build_release()
|
|
|
|
{
|
|
|
|
_xm="build_release ${vdir}"
|
|
|
|
(
|
|
|
|
cd "${srcdir}" || $err "${_xm}: !cd \"${srcdir}\""
|
|
|
|
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-19 07:14:57 +00:00
|
|
|
--abbrev-commit > "${srcdir}/CHANGELOG" || $err "!gitlog $srcdir"
|
2024-05-11 02:52:52 +00:00
|
|
|
|
|
|
|
(
|
2024-05-15 00:32:15 +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"
|
|
|
|
[ "${mode}" = "src" ] && return 0
|
|
|
|
|
|
|
|
(
|
|
|
|
cd "${srcdir}" || $err "${_xm}: 2 !cd \"${srcdir}\""
|
2024-05-15 00:41:19 +00:00
|
|
|
./build roms all || $err "${_xm}: roms-all"
|
|
|
|
./build roms serprog rp2040 || $err "${_xm}: rp2040"
|
|
|
|
./build roms serprog stm32 || $err "${_xm}: stm32"
|
|
|
|
x_ mv bin ../roms
|
2024-05-11 02:52:52 +00:00
|
|
|
) || $err "can't build rom images"
|
|
|
|
|
|
|
|
rm -Rf "${srcdir}" || $err "!rm -Rf ${srcdir}"
|
|
|
|
}
|
|
|
|
|
|
|
|
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-05-11 02:52:52 +00:00
|
|
|
done
|
|
|
|
for x in config/*/build.list; do
|
2024-05-15 02:53:26 +00:00
|
|
|
[ -f "$x" ] && xp="${x#*/}" && xp="${xp%/*}"
|
|
|
|
[ ! -f "$x" ] || [ -L "$xp" ] || x_ rm -Rf "src/$xp/$xp"
|
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-15 01:56:58 +00:00
|
|
|
rm -Rf tmp .git src/u-boot/*/test/lib/strlcat.c || $err "$_xm !rm"
|
2024-05-11 02:52:52 +00:00
|
|
|
}
|
|
|
|
|
2023-10-26 19:11:40 +00:00
|
|
|
fail()
|
|
|
|
{
|
rebase cbmk 9429287 per lbmk c4d90087..f5b04fa5
cbmk 9429287 is the present canoeboot revision, on this day,
two commits after canoeboot 20231107
the cbmk revision was based on lbmk c4d90087, but lbmk
has developed a lot since, right up to f5b04fa5. lbmk
c4d90087 was four commits after libreboot 20231106
this patch brings cbmk up to date, versus lbmk f5b04fa5,
which is 135 commits after libreboot 20231106 (not 4)
therefore, the next canoeboot release shall import lbmk
changes made *after* lbmk revision f5b04fa5. good day!
In English (the above is for my reference, next time
I make a new canoeboot release):
This imports all of the numerous improvements from
Libreboot, sans the non-FSDG-compliant changes. You
can find a full list of such changes in the audit4 page:
https://libreboot.org/news/audit4.html
A full canoeboot-ised changelog will be available in
the next canoeboot release, with these and subsequent
changes. Most notable here is the update to the new
GRUB 2.12 release (instead of 2.12-rc1), and the
improvements Riku made to pico-serprog. And the build
system improvements from lbmk, such as improved, more
generic cmake and autoconf handling.
Canoeboot-specific changes: I also tweaked the deblob
logic, to make it less error-prone. The new design
changes imported into cbmk (based on latest lbmk) somewhat
broke the deblob logic; it was constantly reminding the
user that blobs.list was missing for coreboot,
at config/coreboot/blobs.list - coreboot is a multi-tree
project in both cbmk and lbmk, and the deblob logic was
tuned for single/multi, but was treating coreboot as both.
for simplicity, i removed the check for whether blobs.list
is present. this means that the operator must ensure that
these files are present, in any given revision, where they
are required on a given set of projects (and the files are
all present, in this update to cbmk)
Also of note: the grub.cfg improvements are included in this
cbmk update. The improved grub.cfg can find grub/syslinux
configs by default, not just grub anymore, also finds extlinux,
and will also find them on EFI System Partition - in addition,
UEFI-based install media is also more robust; although cbmk
doesn't provide UEFI configurations on x86, our GRUB palyoad
does still need to work with distro install media, and many
of them now use UEFI-based GRUB configurations in their
installation media, which just happen to work with our GRUB
Signed-off-by: Leah Rowe <leah@libreboot.org>
2024-01-02 11:37:25 +00:00
|
|
|
tmp_cleanup || printf "WARNING: can't rm tmpdir: %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()
|
|
|
|
{
|
|
|
|
[ "${tmpdir_was_set}" = "n" ] || return 0
|
|
|
|
rm -Rf "${tmpdir}" || return 1
|
|
|
|
}
|
|
|
|
|
|
|
|
main $@
|
2024-05-19 07:14:57 +00:00
|
|
|
tmp_cleanup || err_ "can't rm tmpdir upon non-zero exit: $tmpdir"
|