From: Jameson Graef Rollins <jrollins@finestructure.net>
Date: Wed, 29 Jun 2011 17:06:32 +0000 (-0700)
Subject: test: document test_expect_equal_file
X-Git-Tag: 0.7_rc1~28
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=a31ad0bd01570307d18b7fbd56b7bcdfb22e5b63

test: document test_expect_equal_file

This test was not properly documented when it was originally added (my
bad).
---

diff --git a/test/README b/test/README
index 8fbf78da..f9ac6073 100644
--- a/test/README
+++ b/test/README
@@ -156,6 +156,13 @@ library for your script to use.
    will generate a failure and print the difference of the two
    strings.
 
+ test_expect_equal_file <output> <expected>
+
+   Identical to test_exepect_equal, except that <output> and
+   <expected> are files instead of strings.  This is a much more
+   robust method to compare formatted textual information, since it
+   also notices whitespace and closing newline differences.
+
  test_expect_equal_failure <output> <expected>
 
    This works similar to test_expect_equal (see above) but is used to