From: cpickett <cpickett@64e312b2-a51f-0410-8e61-82d0ca0eb02a>
Date: Wed, 6 Feb 2013 21:09:03 +0000 (+0000)
Subject: * fix up description of how ck_assert_msg behaves
X-Git-Tag: 0.10.0~489
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6b8da8f49f39abcdf01e825c56555ba5cb26863e;p=check

* fix up description of how ck_assert_msg behaves


git-svn-id: svn+ssh://svn.code.sf.net/p/check/code/trunk@691 64e312b2-a51f-0410-8e61-82d0ca0eb02a
---

diff --git a/doc/check.texi b/doc/check.texi
index 7f01b13..b55151e 100644
--- a/doc/check.texi
+++ b/doc/check.texi
@@ -561,11 +561,14 @@ ck_assert (money_amount (m) == 5);
 This is equivalent to:
 @example
 @verbatim
-ck_assert_msg (money_amount (m) == 5, 
-              "Assertion 'money_amount (m) == 5' failed");
+ck_assert_msg (money_amount (m) == 5, NULL);
 @end verbatim
 @end example
 
+which will print the file, line number, and the message
+@code{"Assertion 'money_amount (m) == 5' failed"} if
+@code{money_amount (m) != 5}.
+
 When we try to compile and run the test suite now using @command{make
 check}, we get a whole host of compilation errors.  It may seem a bit
 strange to deliberately write code that won't compile, but notice what