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 00:13:46 +03:00
|
|
|
#!/usr/bin/env bash
|
2017-07-19 04:11:08 +03:00
|
|
|
|
|
|
|
# Emulate genhostid(1) available on RHEL/CENTOS, for use on distros
|
|
|
|
# which do not provide that utility.
|
|
|
|
#
|
|
|
|
# Usage:
|
|
|
|
# zgenhostid
|
|
|
|
# zgenhostid <value>
|
|
|
|
#
|
|
|
|
# If /etc/hostid already exists and is size > 0, the script exits immediately
|
|
|
|
# and changes nothing. Unlike genhostid, this generates an error message.
|
|
|
|
#
|
|
|
|
# The first form generates a random hostid and stores it in /etc/hostid.
|
|
|
|
# The second form checks that the provided value is between 0x1 and 0xFFFFFFFF
|
|
|
|
# and if so, stores it in /etc/hostid. This form is not supported by
|
|
|
|
# genhostid(1).
|
|
|
|
|
|
|
|
hostid_file=/etc/hostid
|
|
|
|
|
|
|
|
function usage {
|
|
|
|
echo "$0 [value]"
|
|
|
|
echo "If $hostid_file is not present, store a hostid in it." >&2
|
|
|
|
echo "The optional value must be an 8-digit hex number between" >&2
|
|
|
|
echo "1 and 2^32-1. If no value is provided, a random one will" >&2
|
|
|
|
echo "be generated. The value must be unique among your systems." >&2
|
|
|
|
}
|
|
|
|
|
|
|
|
# hostid(1) ignores contents of /etc/hostid if size < 4 bytes. It would
|
|
|
|
# be better if this checked size >= 4 bytes but it the method must be
|
|
|
|
# widely portable.
|
|
|
|
if [ -s $hostid_file ]; then
|
|
|
|
echo "$hostid_file already exists. No change made." >&2
|
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
|
|
|
if [ -n "$1" ]; then
|
|
|
|
host_id=$1
|
|
|
|
else
|
|
|
|
# $RANDOM goes from 0..32k-1
|
|
|
|
number=$((((RANDOM % 4) * 32768 + RANDOM) * 32768 + RANDOM))
|
|
|
|
host_id=$(printf "%08x" $number)
|
|
|
|
fi
|
|
|
|
|
|
|
|
if egrep -o '^0{8}$' <<< $host_id >/dev/null 2>&1; then
|
|
|
|
usage
|
|
|
|
exit 2
|
|
|
|
fi
|
|
|
|
|
|
|
|
if ! egrep -o '^[a-fA-F0-9]{8}$' <<< $host_id >/dev/null 2>&1; then
|
|
|
|
usage
|
|
|
|
exit 3
|
|
|
|
fi
|
|
|
|
|
|
|
|
a=${host_id:6:2}
|
|
|
|
b=${host_id:4:2}
|
|
|
|
c=${host_id:2:2}
|
|
|
|
d=${host_id:0:2}
|
|
|
|
|
|
|
|
echo -ne \\x$a\\x$b\\x$c\\x$d > $hostid_file
|
|
|
|
|
|
|
|
exit 0
|