Return-Path: <jrollins@servo.finestructure.net>
X-Original-To: notmuch@notmuchmail.org
Delivered-To: notmuch@notmuchmail.org
Received: from localhost (localhost [127.0.0.1])
	by olra.theworths.org (Postfix) with ESMTP id 73666421186
	for <notmuch@notmuchmail.org>; Wed, 29 Jun 2011 10:06:41 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: -1.921
X-Spam-Level: 
X-Spam-Status: No, score=-1.921 tagged_above=-999 required=5
	tests=[NO_DNS_FOR_FROM=0.379, RCVD_IN_DNSWL_MED=-2.3]
	autolearn=disabled
Received: from olra.theworths.org ([127.0.0.1])
	by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
	with ESMTP id TkXznkJdtU-Q for <notmuch@notmuchmail.org>;
	Wed, 29 Jun 2011 10:06:40 -0700 (PDT)
Received: from outgoing-mail.its.caltech.edu (outgoing-mail.its.caltech.edu
	[131.215.239.19])
	by olra.theworths.org (Postfix) with ESMTP id C6300429E5F
	for <notmuch@notmuchmail.org>; Wed, 29 Jun 2011 10:06:40 -0700 (PDT)
Received: from fire-doxen.imss.caltech.edu (localhost [127.0.0.1])
	by fire-doxen-postvirus (Postfix) with ESMTP id ACF9632811D;
	Wed, 29 Jun 2011 09:57:54 -0700 (PDT)
X-Spam-Scanned: at Caltech-IMSS on fire-doxen by amavisd-new
Received: from servo.finestructure.net (cpe-98-149-172-122.socal.res.rr.com
	[98.149.172.122]) (Authenticated sender: jrollins)
	by fire-doxen-submit (Postfix) with ESMTP id 6671432811F;
	Wed, 29 Jun 2011 09:57:51 -0700 (PDT)
Received: by servo.finestructure.net (Postfix, from userid 1000)
	id DA71455D; Wed, 29 Jun 2011 10:06:35 -0700 (PDT)
From: Jameson Graef Rollins <jrollins@finestructure.net>
To: Notmuch Mail <notmuch@notmuchmail.org>
Subject: [PATCH] test: document test_expect_equal_file
Date: Wed, 29 Jun 2011 10:06:32 -0700
Message-Id: <1309367192-16340-1-git-send-email-jrollins@finestructure.net>
X-Mailer: git-send-email 1.7.5.4
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Wed, 29 Jun 2011 17:06:41 -0000

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