In a shell snippet meant to be sourced by other shell scripts, an
opening #! line does more harm than good.
The harm:
- When the shell library is sourced, the interpreter and options from
the #! line are not used. Specifying a particular shell can
confuse the reader into thinking it is safe for the shell library
to rely on idiosyncrasies of that shell.
- Using #! instead of a plain comment drops a helpful visual clue
that this is a shell library and not a self-contained script.
- Tools such as lintian can use a #! line to tell when an
installation script has failed by forgetting to set a script
executable. This check does not work if shell libraries also start
with a #! line.
The good:
- Text editors notice the #! line and use it for syntax highlighting
if you try to edit the installed scripts (without ".sh" suffix) in
place.
The use of the #! for file type detection is not needed because Git's
shell libraries are meant to be edited in source form (with ".sh"
suffix). Replace the opening #! lines with comments.
This involves tweaking the test harness's valgrind support to find
shell libraries by looking for "# " in the first line instead of "#!"
(see v1.7.6-rc3~7, 2011-06-17).
Suggested by Russ Allbery through lintian. Thanks to Jeff King and
Clemens Buchacher for further analysis.
Tested by searching for non-executable scripts with #! line:
find . -name .git -prune -o -type f -not -executable |
while read file
do
read line <"$file"
case $line in
'#!'*)
echo "$file"
;;
esac
done
The only remaining scripts found are templates for shell scripts
(unimplemented.sh, wrap-for-bin.sh) and sample input used in tests
(t/t4034/perl/{pre,post}).
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
76 lines
1.5 KiB
Bash
76 lines
1.5 KiB
Bash
# This shell script fragment is sourced by git-rebase to implement
|
|
# its default, fast, patch-based, non-interactive mode.
|
|
#
|
|
# Copyright (c) 2010 Junio C Hamano.
|
|
#
|
|
|
|
case "$action" in
|
|
continue)
|
|
git am --resolved --resolvemsg="$resolvemsg" &&
|
|
move_to_original_branch
|
|
return
|
|
;;
|
|
skip)
|
|
git am --skip --resolvemsg="$resolvemsg" &&
|
|
move_to_original_branch
|
|
return
|
|
;;
|
|
esac
|
|
|
|
test -n "$rebase_root" && root_flag=--root
|
|
|
|
ret=0
|
|
if test -n "$keep_empty"
|
|
then
|
|
# we have to do this the hard way. git format-patch completely squashes
|
|
# empty commits and even if it didn't the format doesn't really lend
|
|
# itself well to recording empty patches. fortunately, cherry-pick
|
|
# makes this easy
|
|
git cherry-pick --allow-empty "$revisions"
|
|
ret=$?
|
|
else
|
|
rm -f "$GIT_DIR/rebased-patches"
|
|
|
|
git format-patch -k --stdout --full-index --ignore-if-in-upstream \
|
|
--src-prefix=a/ --dst-prefix=b/ --no-renames --no-cover-letter \
|
|
$root_flag "$revisions" >"$GIT_DIR/rebased-patches"
|
|
ret=$?
|
|
|
|
if test 0 != $ret
|
|
then
|
|
rm -f "$GIT_DIR/rebased-patches"
|
|
case "$head_name" in
|
|
refs/heads/*)
|
|
git checkout -q "$head_name"
|
|
;;
|
|
*)
|
|
git checkout -q "$orig_head"
|
|
;;
|
|
esac
|
|
|
|
cat >&2 <<-EOF
|
|
|
|
git encountered an error while preparing the patches to replay
|
|
these revisions:
|
|
|
|
$revisions
|
|
|
|
As a result, git cannot rebase them.
|
|
EOF
|
|
return $?
|
|
fi
|
|
|
|
git am $git_am_opt --rebasing --resolvemsg="$resolvemsg" <"$GIT_DIR/rebased-patches"
|
|
ret=$?
|
|
|
|
rm -f "$GIT_DIR/rebased-patches"
|
|
fi
|
|
|
|
if test 0 != $ret
|
|
then
|
|
test -d "$state_dir" && write_basic_state
|
|
return $ret
|
|
fi
|
|
|
|
move_to_original_branch
|