diff mbox series

[1/2] t/lib-credential.sh: drop shebang line

Message ID 20200326082527.GA3611762@coredump.intra.peff.net (mailing list archive)
State New, archived
Headers show
Series test shell-library cleanups | expand

Commit Message

Jeff King March 26, 2020, 8:25 a.m. UTC
The purpose of lib-credential.sh is to be sourced into other test
scripts. It doesn't need a "#!/bin/sh" line, as running it directly
makes no sense. Nor does it serve any real filetype documentation
purpose, as the file is cleary named with a ".sh" extension.

In the spirit of c74c72034f (test: replace shebangs with descriptions in
shell libraries, 2013-11-25), let's replace it with a human-readable
description.

Signed-off-by: Jeff King <peff@peff.net>
---
I left the similar case in lib-gpg alone so as not to conflict with
Dscho's version.

 t/lib-credential.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Denton Liu March 26, 2020, 8:33 a.m. UTC | #1
On Thu, Mar 26, 2020 at 04:25:27AM -0400, Jeff King wrote:
> The purpose of lib-credential.sh is to be sourced into other test
> scripts. It doesn't need a "#!/bin/sh" line, as running it directly
> makes no sense. Nor does it serve any real filetype documentation
> purpose, as the file is cleary named with a ".sh" extension.

s/cleary/clearly/

Patch and message look obviously good otherwise.
diff mbox series

Patch

diff --git a/t/lib-credential.sh b/t/lib-credential.sh
index 937b831ea6..5ea8bc9f1d 100755
--- a/t/lib-credential.sh
+++ b/t/lib-credential.sh
@@ -1,4 +1,5 @@ 
-#!/bin/sh
+# Shell library for testing credential handling including helpers. See t0302
+# for an example of testing a specific helper.
 
 # Try a set of credential helpers; the expected stdin,
 # stdout and stderr should be provided on stdin,