test: document test_expect_equal_file

This test was not properly documented when it was originally added (my
bad).
This commit is contained in:
Jameson Graef Rollins 2011-06-29 10:06:32 -07:00 committed by Carl Worth
parent f4dae4e5a1
commit a31ad0bd01

View file

@ -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