test-lib functions: expand "test_commit" comment template
Expand the comment template for "test_commit" to match that of "test_commit_bulk" added in b1c36cb849 (test-lib: introduce test_commit_bulk, 2019-07-02). It has several undocumented options, which won't all fit on one line. Follow-up commit(s) will document them. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Jan 12, 2021 at 21:17 UTC
f21426e189f3ace9dcf9d713b2c2f2721515b886
1 file changed
+3
-5
t/test-lib-functions.sh
+3
-5
@@ -178,16 +178,14 @@ debug () {
178
GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7
179
}
180
181
-# Call test_commit with the arguments
182
-# [-C <directory>] <message> [<file> [<contents> [<tag>]]]"
181
+# Usage: test_commit [options] <message> [<file> [<contents> [<tag>]]]
182
+# -C <dir>:
183
+# Run all git commands in directory <dir>
184
#
185
# This will commit a file with the given contents and the given commit
186
# message, and tag the resulting commit with the given tag name.
187
#
188
# <file>, <contents>, and <tag> all default to <message>.
188
-#
189
-# If the first argument is "-C", the second argument is used as a path for
190
-# the git invocations.
189
190
test_commit () {
191
notick= &&