[PATCH/RFC] remove #!interpreter line from shell libraries
From: Jonathan Nieder <hidden>
Date: 2016-06-15 22:53:15
Subsystem:
the rest · Maintainer:
Linus Torvalds
As explained in v1.7.0-rc1~9 (2009-11-25), even when a script is expected to be sourced instead of executed on its own, a #!/bin/sh shebang line can provide useful documentation about what format the file is in. However, it is even clearer to include a comment and no shebang at all, to avoid creating the illusion that the indicated choice of shell will have any effect at runtime. Add some text to each of git's shell libraries explaining in what context the fragment is meant to be sourced and remove the shebangs. Because these files are not marked executable, removing the #! lines would not confuse the valgrind support of our test scripts, so this should be safe. Noticed by lintian. Signed-off-by: Jonathan Nieder <redacted> --- Hi, This patch has only an aesthetic justification but I think it is basically good. Last took a brief visit to the list at [1]. More context at [2]. I'd be happy for any thoughts you have. Thanks, Jonathan [1] http://thread.gmane.org/gmane.comp.version-control.git/185079/focus=185106 [2] http://bugs.debian.org/368792 http://thread.gmane.org/gmane.comp.version-control.git/138253/focus=138560 git-mergetool--lib.sh | 3 +-- git-parse-remote.sh | 4 +++- git-rebase--am.sh | 3 ++- git-rebase--interactive.sh | 8 +++----- git-rebase--merge.sh | 4 +++- git-sh-i18n.sh | 5 ++--- git-sh-setup.sh | 9 +++------ 7 files changed, 17 insertions(+), 19 deletions(-)
diff --git a/git-mergetool--lib.sh b/git-mergetool--lib.sh
index ed630b20..7a0f499b 100644
--- a/git-mergetool--lib.sh
+++ b/git-mergetool--lib.sh@@ -1,5 +1,4 @@ -#!/bin/sh -# git-mergetool--lib is a library for common merge tool functions +# git-mergetool--lib is a shell library for common merge tool functions diff_mode() { test "$TOOL_MODE" = diff }
diff --git a/git-parse-remote.sh b/git-parse-remote.sh
index b24119d6..739ff772 100644
--- a/git-parse-remote.sh
+++ b/git-parse-remote.sh@@ -1,4 +1,6 @@ -#!/bin/sh +# This is a shell library to calculate the remote repository and +# upstream branch that should be pulled by "git pull" from the current +# branch. # git-ls-remote could be called from outside a git managed repository; # this would fail in that case and would issue an error message.
diff --git a/git-rebase--am.sh b/git-rebase--am.sh
index c815a241..5d8d451b 100644
--- a/git-rebase--am.sh
+++ b/git-rebase--am.sh@@ -1,4 +1,5 @@ -#!/bin/sh +# 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. #
diff --git a/git-rebase--interactive.sh b/git-rebase--interactive.sh
index 5812222e..ff00b094 100644
--- a/git-rebase--interactive.sh
+++ b/git-rebase--interactive.sh@@ -1,11 +1,9 @@ -#!/bin/sh # # Copyright (c) 2006 Johannes E. Schindelin -# SHORT DESCRIPTION -# -# This script makes it easy to fix up commits in the middle of a series, -# and rearrange commits. +# This shell script fragment is sourced by git-rebase to implement +# its interactive mode. "git rebase --interactive" makes it easy +# to fix up commits in the middle of a series and rearrange commits. # # The original idea comes from Eric W. Biederman, in # http://article.gmane.org/gmane.comp.version-control.git/22407
diff --git a/git-rebase--merge.sh b/git-rebase--merge.sh
index dc599077..0fa0e491 100644
--- a/git-rebase--merge.sh
+++ b/git-rebase--merge.sh@@ -1,4 +1,6 @@ -#!/bin/sh +# This shell script fragment is sourced by git-rebase to implement +# its merge-based non-interactive mode that copes well with renamed +# files. # # Copyright (c) 2010 Junio C Hamano. #
diff --git a/git-sh-i18n.sh b/git-sh-i18n.sh
index b4575fb3..eff20a08 100644
--- a/git-sh-i18n.sh
+++ b/git-sh-i18n.sh@@ -1,9 +1,8 @@ -#!/bin/sh +# This shell library is Git's interface to gettext.sh. See po/README +# for usage instructions. # # Copyright (c) 2010 Ævar Arnfjörð Bjarmason # -# This is Git's interface to gettext.sh. See po/README for usage -# instructions. # Export the TEXTDOMAIN* data that we need for Git TEXTDOMAIN=git
diff --git a/git-sh-setup.sh b/git-sh-setup.sh
index 5d8e4e6c..51362d60 100644
--- a/git-sh-setup.sh
+++ b/git-sh-setup.sh@@ -1,9 +1,6 @@ -#!/bin/sh -# -# This is included in commands that either have to be run from the toplevel -# of the repository, or with GIT_DIR environment variable properly. -# If the GIT_DIR does not look like the right correct git-repository, -# it dies. +# This shell scriplet is meant to be included by other shell scripts +# to set up some variables pointing at the normal git directories and +# a few helper shell functions. # Having this variable in your environment would break scripts because # you would cause "cd" to be taken to unexpected places. If you
--
1.7.9.2.792.g4ea66.dirty