summaryrefslogtreecommitdiff
path: root/t
diff options
context:
space:
mode:
authorLibravatar Ævar Arnfjörð Bjarmason <avarab@gmail.com>2021-01-12 21:17:57 +0100
committerLibravatar Junio C Hamano <gitster@pobox.com>2021-01-12 14:04:41 -0800
commit76b8b8d05c723232f27d9396d3ddfd2b10394187 (patch)
treedc0ed7b919b4192f4c552a7edf5726c8bdaf1f1d /t
parenttest-lib functions: expand "test_commit" comment template (diff)
downloadtgif-76b8b8d05c723232f27d9396d3ddfd2b10394187.tar.xz
test-lib functions: document arguments to test_commit
The --notick argument was added in [1] and was followed by --signoff in [2], but neither of these commits added any documentation for these options. When -C was added in [3] a comment was added to document it, but not the other options. Let's document all of these options. 1. 44b85e89d7 (t7003: add test to filter a branch with a commit at epoch, 2012-07-12), 2. 5ed75e2a3f (cherry-pick: don't forget -s on failure, 2012-09-14). 3. 6f94351b0a (test-lib-functions.sh: teach test_commit -C <dir>, 2016-12-08) Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 't')
-rw-r--r--t/test-lib-functions.sh4
1 files changed, 4 insertions, 0 deletions
diff --git a/t/test-lib-functions.sh b/t/test-lib-functions.sh
index 396e039d2a..194b601bc0 100644
--- a/t/test-lib-functions.sh
+++ b/t/test-lib-functions.sh
@@ -181,6 +181,10 @@ debug () {
# Usage: test_commit [options] <message> [<file> [<contents> [<tag>]]]
# -C <dir>:
# Run all git commands in directory <dir>
+# --notick
+# Do not call test_tick before making a commit
+# --signoff
+# Invoke "git commit" with --signoff
#
# This will commit a file with the given contents and the given commit
# message, and tag the resulting commit with the given tag name.