From: Denton Liu <liu.denton@gmail.com>
Date: Thu, 14 Jan 2021 23:02:40 +0000 (-0800)
Subject: test-lib-functions.sh: fix usage for test_commit()
X-Git-Tag: v2.31.0-rc0~93^2~3
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f9f30a03107742dc4270dc8e37bc519adc96a475;p=thirdparty%2Fgit.git

test-lib-functions.sh: fix usage for test_commit()

The usage comment for test_commit() shows that the --author option
should be given as `--author=<author>`. However, this is incorrect as it
only works when given as `--author <author>`. Correct this erroneous
text.

Also, for the sake of correctness, fix the description as well since we
invoke `git commit` with `--author <author>`, not `--author=<author>`.

Signed-off-by: Denton Liu <liu.denton@gmail.com>
Acked-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/t/test-lib-functions.sh b/t/test-lib-functions.sh
index b0a5d74dc7..cea73cb8f0 100644
--- a/t/test-lib-functions.sh
+++ b/t/test-lib-functions.sh
@@ -188,8 +188,8 @@ debug () {
 #	"<file>"
 #   --signoff
 #	Invoke "git commit" with --signoff
-#   --author=<author>
-#	Invoke "git commit" with --author=<author>
+#   --author <author>
+#	Invoke "git commit" with --author <author>
 #
 # This will commit a file with the given contents and the given commit
 # message, and tag the resulting commit with the given tag name.