[PATCH 8/9] test: replace shebangs with descriptions in shell libraries

2013-11-25 Thread Jonathan Nieder
A #! line in these files is misleading, since these scriptlets are
meant to be sourced with '.' (using whatever shell sources them)
instead of run directly using the interpreter named on the #! line.

Removing the #! line shouldn't hurt syntax highlighting since
these files have filenames ending with '.sh'.  For documentation,
add a brief description of how the files are meant to be used in
place of the shebang line.

Signed-off-by: Jonathan Nieder jrnie...@gmail.com
---
 t/gitweb-lib.sh   |  3 ++-
 t/lib-bash.sh |  7 +++
 t/lib-cvs.sh  |  2 +-
 t/lib-diff-alternative.sh |  3 ++-
 t/lib-gettext.sh  |  3 ++-
 t/lib-git-daemon.sh   | 18 +-
 t/lib-httpd.sh| 29 -
 t/lib-pack.sh |  2 --
 t/lib-pager.sh|  2 +-
 t/lib-read-tree.sh|  2 --
 t/lib-rebase.sh   |  2 +-
 t/lib-terminal.sh |  2 +-
 t/perf/perf-lib.sh|  4 +++-
 t/test-lib-functions.sh   |  3 ++-
 t/test-lib.sh |  2 +-
 15 files changed, 64 insertions(+), 20 deletions(-)

diff --git a/t/gitweb-lib.sh b/t/gitweb-lib.sh
index 8cf909a..d5dab5a 100644
--- a/t/gitweb-lib.sh
+++ b/t/gitweb-lib.sh
@@ -1,4 +1,5 @@
-#!/bin/sh
+# Initialization and helpers for Gitweb tests, which source this
+# shell library instead of test-lib.sh.
 #
 # Copyright (c) 2007 Jakub Narebski
 #
diff --git a/t/lib-bash.sh b/t/lib-bash.sh
index 11397f7..10b76df 100644
--- a/t/lib-bash.sh
+++ b/t/lib-bash.sh
@@ -1,7 +1,6 @@
-#!/bin/sh
-#
-# Ensures that tests are run under Bash; primarily intended for running tests
-# of the completion script.
+# Shell library sourced instead of ./test-lib.sh by tests that need
+# to run under Bash; primary intended for tests of the completion
+# script.
 
 if test -n $BASH  test -z $POSIXLY_CORRECT; then
# we are in full-on bash mode
diff --git a/t/lib-cvs.sh b/t/lib-cvs.sh
index 44263ad..5076718 100644
--- a/t/lib-cvs.sh
+++ b/t/lib-cvs.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+# Shell library sourced instead of ./test-lib.sh by cvsimport tests.
 
 . ./test-lib.sh
 
diff --git a/t/lib-diff-alternative.sh b/t/lib-diff-alternative.sh
index 75ffd91..8b4dbf2 100644
--- a/t/lib-diff-alternative.sh
+++ b/t/lib-diff-alternative.sh
@@ -1,4 +1,5 @@
-#!/bin/sh
+# Helpers shared by the test scripts for diff algorithms (patience,
+# histogram, etc).
 
 test_diff_frobnitz() {
cat file1 \EOF
diff --git a/t/lib-gettext.sh b/t/lib-gettext.sh
index ae8883a..eec757f 100644
--- a/t/lib-gettext.sh
+++ b/t/lib-gettext.sh
@@ -1,4 +1,5 @@
-#!/bin/sh
+# Initialization and Icelandic locale for basic git i18n tests,
+# which source this scriptlet instead of ./test-lib.sh.
 #
 # Copyright (c) 2010 Ævar Arnfjörð Bjarmason
 #
diff --git a/t/lib-git-daemon.sh b/t/lib-git-daemon.sh
index 87f0ad8..394b06b 100644
--- a/t/lib-git-daemon.sh
+++ b/t/lib-git-daemon.sh
@@ -1,4 +1,20 @@
-#!/bin/sh
+# Shell library to run git-daemon in tests.  Ends the test early if
+# GIT_TEST_GIT_DAEMON is not set.
+#
+# Usage:
+#
+#  . ./test-lib.sh
+#  . $TEST_DIRECTORY/lib-git-daemon.sh
+#  start_git_daemon
+#
+#  test_expect_success '...' '
+#  ...
+#  '
+#
+#  test_expect_success ...
+#
+#  stop_git_daemon
+#  test_done
 
 if test -z $GIT_TEST_GIT_DAEMON
 then
diff --git a/t/lib-httpd.sh b/t/lib-httpd.sh
index ad8f1ef..c470784 100644
--- a/t/lib-httpd.sh
+++ b/t/lib-httpd.sh
@@ -1,4 +1,31 @@
-#!/bin/sh
+# Shell library to run an HTTP server for use in tests.
+# Ends the test early if httpd tests should not be run,
+# for example because the user has not enabled them.
+#
+# Usage:
+#
+#  . ./test-lib.sh
+#  . $TEST_DIRECTORY/lib-httpd.sh
+#  start_httpd
+#
+#  test_expect_success '...' '
+#  ...
+#  '
+#
+#  test_expect_success ...
+#
+#  stop_httpd
+#  test_done
+#
+# Can be configured using the following variables.
+#
+#GIT_TEST_HTTPD  enable HTTPD tests
+#LIB_HTTPD_PATH  web server path
+#LIB_HTTPD_MODULE_PATH   web server modules path
+#LIB_HTTPD_PORT  listening port
+#LIB_HTTPD_DAV   enable DAV
+#LIB_HTTPD_SVN   enable SVN
+#LIB_HTTPD_SSL   enable SSL
 #
 # Copyright (c) 2008 Clemens Buchacher dri...@aon.at
 #
diff --git a/t/lib-pack.sh b/t/lib-pack.sh
index b96e125..7509846 100644
--- a/t/lib-pack.sh
+++ b/t/lib-pack.sh
@@ -1,5 +1,3 @@
-#!/bin/sh
-#
 # Support routines for hand-crafting weird or malicious packs.
 #
 # You can make a complete pack like:
diff --git a/t/lib-pager.sh b/t/lib-pager.sh
index ba03eab..3aa7a3f 100644
--- a/t/lib-pager.sh
+++ b/t/lib-pager.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+# Helpers for tests of git's choice of pager.
 
 test_expect_success 'determine default pager' '
test_might_fail git config --unset core.pager 
diff --git a/t/lib-read-tree.sh b/t/lib-read-tree.sh
index abc2c6f..6442ae3 100644
--- 

Re: [PATCH 8/9] test: replace shebangs with descriptions in shell libraries

2013-11-25 Thread Eric Sunshine
On Mon, Nov 25, 2013 at 4:03 PM, Jonathan Nieder jrnie...@gmail.com wrote:
 A #! line in these files is misleading, since these scriptlets are
 meant to be sourced with '.' (using whatever shell sources them)
 instead of run directly using the interpreter named on the #! line.

 Removing the #! line shouldn't hurt syntax highlighting since
 these files have filenames ending with '.sh'.  For documentation,
 add a brief description of how the files are meant to be used in
 place of the shebang line.

 Signed-off-by: Jonathan Nieder jrnie...@gmail.com
 ---
 diff --git a/t/lib-bash.sh b/t/lib-bash.sh
 index 11397f7..10b76df 100644
 --- a/t/lib-bash.sh
 +++ b/t/lib-bash.sh
 @@ -1,7 +1,6 @@
 -#!/bin/sh
 -#
 -# Ensures that tests are run under Bash; primarily intended for running tests
 -# of the completion script.
 +# Shell library sourced instead of ./test-lib.sh by tests that need
 +# to run under Bash; primary intended for tests of the completion

s/primary/primarily/

 +# script.

  if test -n $BASH  test -z $POSIXLY_CORRECT; then
 # we are in full-on bash mode
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html