t/README: document test_cmp_rev
authorThomas Gummerer <t.gummerer@gmail.com>
Sun, 26 Nov 2017 20:21:00 +0000 (20:21 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 27 Nov 2017 01:36:58 +0000 (10:36 +0900)
test_cmp_rev is a useful function that's used in quite a few test
scripts.  It is however not documented in t/README.  Document it.

Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
t/README

index 448569b..e867d1f 100644 (file)
--- a/t/README
+++ b/t/README
@@ -674,6 +674,11 @@ library for your script to use.
    <expected> file.  This behaves like "cmp" but produces more
    helpful output when the test is run with "-v" option.
 
+ - test_cmp_rev <expected> <actual>
+
+   Check whether the <expected> rev points to the same commit as the
+   <actual> rev.
+
  - test_line_count (= | -lt | -ge | ...) <length> <file>
 
    Check whether a file has the length it is expected to.