bash scripts: use /usr/bin/env for bash shebangs
Not all systems / distros have a `/bin/bash`, and these scripts are
more difficult to run at development time.
For example, my system is NixOS which doesn't have a /bin/bash. This
is not a problem for NixOS building ZFS as a package: the build
environment automatically replaces these shebangs with corrected
paths.
The problem is much more annoying at development time: either the
scripts don't run, or I correct them for my local machine and deal with
a perpetually dirty work tree.
Before committing this patch I confirmed there are existing scripts
which use `/usr/bin/env` to locate bash, so I am thinking this is a
safe transformation.
There are a handful of other shebangs in this repository which don't
work on my system. This patch is useful on its own specifically for
`commitcheck.sh`, otherwise I can't validate my commits before
submission.
Here are the remaining shebangs which NixOS systems won't have:
1274 #!/bin/ksh -p
91 #!/bin/ksh
89 #! /bin/ksh -p
2 #!/bin/sed -f
1 #!/usr/bin/perl -w
1 #!/usr/bin/ksh
1 #!/bin/nawk -f
plus this which will create an invalid shebang in
`tests/zfs-tests/tests/functional/mv_files/mv_files_common.kshlib`:
echo "#!/bin/ksh" > $TEST_BASE_DIR/exitsZero.ksh
I chose to leave those alone for now, and gauge the interest in this
much smaller patch first.
The fixes for these are easy enough by simply using `/usr/bin/env ksh`:
91 #!/bin/ksh
1 #!/usr/bin/ksh
The fix for the other set is much trickier. Quoting the GNU coreutils
manual:
Most operating systems (e.g. GNU/Linux, BSDs) treat all text after
the first space as a single argument. When using env in a script it
is thus not possible to specify multiple arguments.
and not all `env`'s support arguments.
Mine (GNU Coreutils 8.31) does, though this feature is new since
April 2018, GNU Coreutils 8.30:
https://git.savannah.gnu.org/cgit/coreutils.git/commit/?id=668306ed86c8c79b0af0db8b9c882654ebb66db2
and worse, requires the -S argument:
-S, --split-string=S process and split S into separate arguments;
used to pass multiple arguments on shebang
lines
Example:
$ seq 1 2 | $(nix-build '<nixpkgs>' -A coreutils)/bin/env "sort -nr"
/nix/[...]-coreutils-8.31/bin/env: ‘sort -nr’: No such file or directory
/nix/[...]-coreutils-8.31/bin/env: use -[v]S to pass options in shebang lines
$ seq 1 2 | $(nix-build '<nixpkgs>' -A coreutils)/bin/env "-S sort -nr"
2
1
GNU Coreutils says FreeBSD's `env` does, though I wonder if FreeBSD's
would be unhappy with the `-S`:
https://www.gnu.org/software/coreutils/manual/html_node/env-invocation.html#env-invocation
BusyBox v1.30.1 does not, and does not have a `-S`-like option:
$ seq 1 2 | $(nix-build '<nixpkgs>' -A busybox)/bin/env "sort -nr"
env: can't execute 'sort -nr': No such file or directory
Toybox 0.8.1 also does not, and also does not have a `-S` option:
$ seq 1 2 | $(nix-build '<nixpkgs>' -A toybox)/bin/env "sort -nr"
env: exec sort -nr: No such file or directory
---
At any rate, if this patch merges and the remaining ~1,500 are updated,
the much larger patch should probably include a checkstyle-like test
asserting all new shebangs use `/usr/bin/env`. I also don't mind
dealing with NixOS weirdness if the project would prefer that.
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: Graham Christensen <graham@grahamc.com>
Closes #9893
2020-02-11 05:13:46 +08:00
|
|
|
#!/usr/bin/env bash
|
2012-07-09 17:23:00 +08:00
|
|
|
|
|
|
|
|
set -e
|
|
|
|
|
|
|
|
|
|
usage()
|
|
|
|
|
{
|
|
|
|
|
echo "usage: $0 <kernel source tree>" >&2
|
|
|
|
|
exit 1
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
[ "$#" -eq 1 ] || usage
|
|
|
|
|
KERNEL_DIR="$(readlink --canonicalize-existing "$1")"
|
|
|
|
|
|
|
|
|
|
MODULES=()
|
2019-09-12 02:09:50 +08:00
|
|
|
|
|
|
|
|
# When integrated in to a monolithic kernel the spl module must appear
|
|
|
|
|
# first. This ensures its module initialization function is run before
|
|
|
|
|
# any of the other module initialization functions which depend on it.
|
|
|
|
|
MODULES+="spl"
|
|
|
|
|
|
2019-09-07 02:26:26 +08:00
|
|
|
for MODULE_DIR in module/* module/os/linux/*
|
2012-07-09 17:23:00 +08:00
|
|
|
do
|
|
|
|
|
[ -d "$MODULE_DIR" ] || continue
|
2019-09-12 02:09:50 +08:00
|
|
|
[ "spl" = "${MODULE_DIR##*/}" ] && continue
|
2019-09-07 02:26:26 +08:00
|
|
|
[ "os" = "${MODULE_DIR#*/}" ] && continue
|
|
|
|
|
MODULES+=("${MODULE_DIR#*/}")
|
2012-07-09 17:23:00 +08:00
|
|
|
done
|
|
|
|
|
|
|
|
|
|
if ! [ -e 'zfs_config.h' ]
|
|
|
|
|
then
|
|
|
|
|
echo >&2
|
|
|
|
|
echo " $0: you did not run configure, or you're not in the ZFS source directory." >&2
|
|
|
|
|
echo " $0: run configure with --with-linux=$KERNEL_DIR and --enable-linux-builtin." >&2
|
|
|
|
|
echo >&2
|
|
|
|
|
exit 1
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
make clean || true
|
2018-10-18 03:06:05 +08:00
|
|
|
scripts/make_gitrev.sh || true
|
2012-07-09 17:23:00 +08:00
|
|
|
|
|
|
|
|
rm -rf "$KERNEL_DIR/include/zfs" "$KERNEL_DIR/fs/zfs"
|
|
|
|
|
cp --recursive include "$KERNEL_DIR/include/zfs"
|
|
|
|
|
cp --recursive module "$KERNEL_DIR/fs/zfs"
|
2018-02-16 09:53:18 +08:00
|
|
|
cp zfs_config.h "$KERNEL_DIR/include/zfs/"
|
2012-07-09 17:23:00 +08:00
|
|
|
|
|
|
|
|
for MODULE in "${MODULES[@]}"
|
|
|
|
|
do
|
2015-12-02 10:24:40 +08:00
|
|
|
sed -i.bak '/obj =/d' "$KERNEL_DIR/fs/zfs/$MODULE/Makefile"
|
|
|
|
|
sed -i.bak '/src =/d' "$KERNEL_DIR/fs/zfs/$MODULE/Makefile"
|
2012-07-09 17:23:00 +08:00
|
|
|
done
|
|
|
|
|
|
|
|
|
|
cat > "$KERNEL_DIR/fs/zfs/Kconfig" <<"EOF"
|
|
|
|
|
config ZFS
|
2012-08-26 05:16:23 +08:00
|
|
|
tristate "ZFS filesystem support"
|
2012-07-29 17:43:57 +08:00
|
|
|
depends on EFI_PARTITION
|
|
|
|
|
select ZLIB_INFLATE
|
|
|
|
|
select ZLIB_DEFLATE
|
2012-07-09 17:23:00 +08:00
|
|
|
help
|
|
|
|
|
This is the ZFS filesystem from the ZFS On Linux project.
|
|
|
|
|
|
2020-01-14 08:43:59 +08:00
|
|
|
See https://zfsonlinux.org/
|
2012-07-09 17:23:00 +08:00
|
|
|
|
|
|
|
|
To compile this file system support as a module, choose M here.
|
|
|
|
|
|
|
|
|
|
If unsure, say N.
|
|
|
|
|
EOF
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
cat <<-"EOF"
|
2017-03-28 03:31:15 +08:00
|
|
|
ZFS_MODULE_CFLAGS = -I$(srctree)/include/zfs
|
2019-09-06 00:34:54 +08:00
|
|
|
ZFS_MODULE_CFLAGS += -I$(srctree)/include/zfs/os/linux/spl
|
|
|
|
|
ZFS_MODULE_CFLAGS += -I$(srctree)/include/zfs/os/linux/zfs
|
|
|
|
|
ZFS_MODULE_CFLAGS += -I$(srctree)/include/zfs/os/linux/kernel
|
2018-02-16 09:53:18 +08:00
|
|
|
ZFS_MODULE_CFLAGS += -include $(srctree)/include/zfs/zfs_config.h
|
2018-01-13 01:39:36 +08:00
|
|
|
ZFS_MODULE_CFLAGS += -std=gnu99 -Wno-declaration-after-statement
|
2018-02-16 09:53:18 +08:00
|
|
|
ZFS_MODULE_CPPFLAGS = -D_KERNEL
|
2018-01-13 01:39:36 +08:00
|
|
|
ZFS_MODULE_CPPFLAGS += -UDEBUG -DNDEBUG
|
|
|
|
|
export ZFS_MODULE_CFLAGS ZFS_MODULE_CPPFLAGS
|
2012-07-09 17:23:00 +08:00
|
|
|
|
|
|
|
|
obj-$(CONFIG_ZFS) :=
|
|
|
|
|
EOF
|
|
|
|
|
|
|
|
|
|
for MODULE in "${MODULES[@]}"
|
|
|
|
|
do
|
|
|
|
|
echo 'obj-$(CONFIG_ZFS) += ' "$MODULE/"
|
|
|
|
|
done
|
|
|
|
|
} > "$KERNEL_DIR/fs/zfs/Kbuild"
|
|
|
|
|
|
|
|
|
|
add_after()
|
|
|
|
|
{
|
|
|
|
|
local FILE="$1"
|
|
|
|
|
local MARKER="$2"
|
|
|
|
|
local NEW="$3"
|
|
|
|
|
local LINE
|
|
|
|
|
|
|
|
|
|
while IFS='' read -r LINE
|
|
|
|
|
do
|
|
|
|
|
echo "$LINE"
|
|
|
|
|
|
|
|
|
|
if [ -n "$MARKER" -a "$LINE" = "$MARKER" ]
|
|
|
|
|
then
|
|
|
|
|
echo "$NEW"
|
|
|
|
|
MARKER=''
|
|
|
|
|
if IFS='' read -r LINE
|
|
|
|
|
then
|
|
|
|
|
[ "$LINE" != "$NEW" ] && echo "$LINE"
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
done < "$FILE" > "$FILE.new"
|
|
|
|
|
|
|
|
|
|
mv "$FILE.new" "$FILE"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
add_after "$KERNEL_DIR/fs/Kconfig" 'if BLOCK' 'source "fs/zfs/Kconfig"'
|
|
|
|
|
add_after "$KERNEL_DIR/fs/Makefile" 'endif' 'obj-$(CONFIG_ZFS) += zfs/'
|
|
|
|
|
|
|
|
|
|
echo >&2
|
|
|
|
|
echo " $0: done." >&2
|
|
|
|
|
echo " $0: now you can build the kernel with ZFS support." >&2
|
|
|
|
|
echo " $0: make sure you enable ZFS support (CONFIG_ZFS) before building." >&2
|
|
|
|
|
echo >&2
|