remove #!interpreter line from shell libraries

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>

Jonathan Nieder committed Nov 25, 2013 at 13:03 UTC 11d62145b904b81013d1ad558d68a74e22e81a91
10 files changed +19 -28
contrib/completion/git-completion.bash
-2
@@ -1,5 +1,3 @@
1 -#!bash
2 -#
1 # bash/zsh completion support for core Git.
2 #
3 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
contrib/completion/git-completion.tcsh
-2
@@ -1,5 +1,3 @@
1 -#!tcsh
2 -#
1 # tcsh completion support for core Git.
2 #
3 # Copyright (C) 2012 Marc Khouzam <marc.khouzam@gmail.com>
git-mergetool--lib.sh
+1 -2
@@ -1,5 +1,4 @@
1 -#!/bin/sh
2 -# git-mergetool--lib is a library for common merge tool functions
1 +# git-mergetool--lib is a shell library for common merge tool functions
2
3 : ${MERGE_TOOLS_DIR=$(git --exec-path)/mergetools}
4
git-parse-remote.sh
+3 -1
@@ -1,4 +1,6 @@
1 -#!/bin/sh
1 +# This is a shell library to calculate the remote repository and
2 +# upstream branch that should be pulled by "git pull" from the current
3 +# branch.
4
5 # git-ls-remote could be called from outside a git managed repository;
6 # this would fail in that case and would issue an error message.
git-rebase--am.sh
+2 -1
@@ -1,4 +1,5 @@
1 -#!/bin/sh
1 +# This shell script fragment is sourced by git-rebase to implement
2 +# its default, fast, patch-based, non-interactive mode.
3 #
4 # Copyright (c) 2010 Junio C Hamano.
5 #
git-rebase--interactive.sh
+3 -6
@@ -1,11 +1,8 @@
1 -#!/bin/sh
1 +# This shell script fragment is sourced by git-rebase to implement
2 +# its interactive mode. "git rebase --interactive" makes it easy
3 +# to fix up commits in the middle of a series and rearrange commits.
4 #
5 # Copyright (c) 2006 Johannes E. Schindelin
4 -
5 -# SHORT DESCRIPTION
6 -#
7 -# This script makes it easy to fix up commits in the middle of a series,
8 -# and rearrange commits.
6 #
7 # The original idea comes from Eric W. Biederman, in
8 # http://article.gmane.org/gmane.comp.version-control.git/22407
git-rebase--merge.sh
+3 -1
@@ -1,4 +1,6 @@
1 -#!/bin/sh
1 +# This shell script fragment is sourced by git-rebase to implement
2 +# its merge-based non-interactive mode that copes well with renamed
3 +# files.
4 #
5 # Copyright (c) 2010 Junio C Hamano.
6 #
git-sh-i18n.sh
+2 -3
@@ -1,9 +1,8 @@
1 -#!/bin/sh
1 +# This shell library is Git's interface to gettext.sh. See po/README
2 +# for usage instructions.
3 #
4 # Copyright (c) 2010 Ævar Arnfjörð Bjarmason
5 #
5 -# This is Git's interface to gettext.sh. See po/README for usage
6 -# instructions.
6
7 # Export the TEXTDOMAIN* data that we need for Git
8 TEXTDOMAIN=git
git-sh-setup.sh
+3 -6
@@ -1,9 +1,6 @@
1 -#!/bin/sh
2 -#
3 -# This is included in commands that either have to be run from the toplevel
4 -# of the repository, or with GIT_DIR environment variable properly.
5 -# If the GIT_DIR does not look like the right correct git-repository,
6 -# it dies.
1 +# This shell scriplet is meant to be included by other shell scripts
2 +# to set up some variables pointing at the normal git directories and
3 +# a few helper shell functions.
4
5 # Having this variable in your environment would break scripts because
6 # you would cause "cd" to be taken to unexpected places. If you
t/test-lib.sh
+2 -4
@@ -573,11 +573,9 @@ then
573
574 make_valgrind_symlink () {
575 # handle only executables, unless they are shell libraries that
576 - # need to be in the exec-path. We will just use "#!" as a
577 - # guess for a shell-script, since we have no idea what the user
578 - # may have configured as the shell path.
576 + # need to be in the exec-path.
577 test -x "$1" ||
580 - test "#!" = "$(head -c 2 <"$1")" ||
578 + test "# " = "$(head -c 2 <"$1")" ||
579 return;
580
581 base=$(basename "$1")