[PATCH] test: document test_expect_equal_file

diff --git a/9d/c22422ed7caa356317449b7a9d9b47d653cd23 b/9d/c22422ed7caa356317449b7a9d9b47d653cd23
new file mode 100644 (file)
index 0000000..74c75ce
--- /dev/null
+++ b/9d/c22422ed7caa356317449b7a9d9b47d653cd23
@@ -0,0 +1,78 @@
+Return-Path: <jrollins@servo.finestructure.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 73666421186\r
+       for <notmuch@notmuchmail.org>; Wed, 29 Jun 2011 10:06:41 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.921\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.921 tagged_above=-999 required=5\r
+       tests=[NO_DNS_FOR_FROM=0.379, RCVD_IN_DNSWL_MED=-2.3]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id TkXznkJdtU-Q for <notmuch@notmuchmail.org>;\r
+       Wed, 29 Jun 2011 10:06:40 -0700 (PDT)\r
+Received: from outgoing-mail.its.caltech.edu (outgoing-mail.its.caltech.edu\r
+       [131.215.239.19])\r
+       by olra.theworths.org (Postfix) with ESMTP id C6300429E5F\r
+       for <notmuch@notmuchmail.org>; Wed, 29 Jun 2011 10:06:40 -0700 (PDT)\r
+Received: from fire-doxen.imss.caltech.edu (localhost [127.0.0.1])\r
+       by fire-doxen-postvirus (Postfix) with ESMTP id ACF9632811D;\r
+       Wed, 29 Jun 2011 09:57:54 -0700 (PDT)\r
+X-Spam-Scanned: at Caltech-IMSS on fire-doxen by amavisd-new\r
+Received: from servo.finestructure.net (cpe-98-149-172-122.socal.res.rr.com\r
+       [98.149.172.122]) (Authenticated sender: jrollins)\r
+       by fire-doxen-submit (Postfix) with ESMTP id 6671432811F;\r
+       Wed, 29 Jun 2011 09:57:51 -0700 (PDT)\r
+Received: by servo.finestructure.net (Postfix, from userid 1000)\r
+       id DA71455D; Wed, 29 Jun 2011 10:06:35 -0700 (PDT)\r
+From: Jameson Graef Rollins <jrollins@finestructure.net>\r
+To: Notmuch Mail <notmuch@notmuchmail.org>\r
+Subject: [PATCH] test: document test_expect_equal_file\r
+Date: Wed, 29 Jun 2011 10:06:32 -0700\r
+Message-Id: <1309367192-16340-1-git-send-email-jrollins@finestructure.net>\r
+X-Mailer: git-send-email 1.7.5.4\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 29 Jun 2011 17:06:41 -0000\r
+\r
+This test was not properly documented when it was originally added (my\r
+bad).\r
+---\r
+ test/README |    7 +++++++\r
+ 1 files changed, 7 insertions(+), 0 deletions(-)\r
+\r
+diff --git a/test/README b/test/README\r
+index 8fbf78d..f9ac607 100644\r
+--- a/test/README\r
++++ b/test/README\r
+@@ -156,6 +156,13 @@ library for your script to use.\r
+    will generate a failure and print the difference of the two\r
+    strings.\r
+ \r
++ test_expect_equal_file <output> <expected>\r
++\r
++   Identical to test_exepect_equal, except that <output> and\r
++   <expected> are files instead of strings.  This is a much more\r
++   robust method to compare formatted textual information, since it\r
++   also notices whitespace and closing newline differences.\r
++\r
+  test_expect_equal_failure <output> <expected>\r
+ \r
+    This works similar to test_expect_equal (see above) but is used to\r
+-- \r
+1.7.5.4\r
+\r