[PATCH] test: document test_expect_equal_file

Subject: [PATCH] test: document test_expect_equal_file

Date: Wed, 29 Jun 2011 10:06:32 -0700

To: Notmuch Mail

Cc:

From: Jameson Graef Rollins

This test was not properly documented when it was originally added (my
bad).
---
 test/README |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/test/README b/test/README
index 8fbf78d..f9ac607 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
-- 
1.7.5.4

Thread: