[PATCH 13/22] test-lib functions: document arguments to test_commit
- From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- Date
- Jan 12, 2021, 20:17 UTC
- Message-ID
- <20210112201806.13284-14-avarab@gmail.com>
- In-Reply-To
- <20210105130359.21139-1-avarab@gmail.com>
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> --- t/test-lib-functions.sh | 4 ++++ 1 file changed, 4 insertions(+)
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.
-- 2.29.2.222.g5d2a92d10f8