t1404: document function test_update_rejected

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Michael Haggerty committed Jun 10, 2016 at 08:55 UTC 017f7221abe6129a41c6a7d2b4ce990f477be74f
1 file changed +10
t/t1404-update-ref-errors.sh
+10
@@ -3,6 +3,16 @@
3 test_description='Test git update-ref error handling'
4 . ./test-lib.sh
5
6 +# Create some references, perhaps run pack-refs --all, then try to
7 +# create some more references. Ensure that the second creation fails
8 +# with the correct error message.
9 +# Usage: test_update_rejected <before> <pack> <create> <error>
10 +# <before> is a ws-separated list of refs to create before the test
11 +# <pack> (true or false) tells whether to pack the refs before the test
12 +# <create> is a list of variables to attempt creating
13 +# <error> is a string to look for in the stderr of update-ref.
14 +# All references are created in the namespace specified by the current
15 +# value of $prefix.
16 test_update_rejected () {
17 before="$1" &&
18 pack="$2" &&