Skip to content

Commit f21426e

Browse files
avargitster
authored andcommitted
test-lib functions: expand "test_commit" comment template
Expand the comment template for "test_commit" to match that of "test_commit_bulk" added in b1c36cb (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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 56ac194 commit f21426e

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

t/test-lib-functions.sh

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,16 +178,14 @@ debug () {
178178
GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7
179179
}
180180

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>
183184
#
184185
# This will commit a file with the given contents and the given commit
185186
# message, and tag the resulting commit with the given tag name.
186187
#
187188
# <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.
191189

192190
test_commit () {
193191
notick= &&

0 commit comments

Comments
 (0)