[PATCH v1 2/2] t/README: document test_cmp_rev

From: Thomas Gummerer <t.gummerer@gmail.com>
Date: Nov 26, 2017, 20:21 UTC
Message-ID: <20171126202100.1658-2-t.gummerer@gmail.com>
In-Reply-To: <20171126202100.1658-1-t.gummerer@gmail.com>

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>
---
 t/README | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/t/README b/t/README
index 448569b60e..e867d1f8bd 100644
--- 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.

-- 
2.15.0.426.gb06021eeb