[Gnash-commit] gnash ./ChangeLog doc/C/internals.xml

[strk]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         
Changes by:     strk <address@hidden>   06/04/27 08:55:14

Modified files:
        .              : ChangeLog 
        doc/C          : internals.xml 

Log message:
        * doc/C/internals.xml: added note about check_equals() macro
        under testing section.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/ChangeLog.diff?tr1=1.241&tr2=1.242&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/doc/C/internals.xml.diff?tr1=1.18&tr2=1.19&r1=text&r2=text

Patches:
Index: gnash/ChangeLog
diff -u gnash/ChangeLog:1.241 gnash/ChangeLog:1.242
--- gnash/ChangeLog:1.241       Thu Apr 27 08:41:45 2006
+++ gnash/ChangeLog     Thu Apr 27 08:55:14 2006
@@ -8,6 +8,8 @@
        AS class registration, System.capabilities.version
        implementation and scheleton for AS instanciation of it
        (the latter being untested).
+       * doc/C/internals.xml: added note about check_equals() macro
+       under testing section.
 
 2006-04-26  Timo Lindfors <address@hidden>
 
Index: gnash/doc/C/internals.xml
diff -u gnash/doc/C/internals.xml:1.18 gnash/doc/C/internals.xml:1.19
--- gnash/doc/C/internals.xml:1.18      Sat Apr 22 03:12:08 2006
+++ gnash/doc/C/internals.xml   Thu Apr 27 08:55:14 2006
@@ -1781,17 +1781,29 @@
          
          // Test parseInt
          check(isNaN(parseInt('none')));
+
+         // Test assignment
+         var a = 1;
+         check_equals(a, 1);
          
          // .. your tests here ...
        </programlisting>
       </para>
       
       <para>
-       The check() macro will <code>trace</code> PASSED or FAILED
+       The check(expr) macro will <code>trace</code> PASSED or FAILED
        together with the expression being evaluated, the filename and
        the linenumber of the check. This is the format expected by
        DejaGnu.
       </para>
+
+      <para>
+       The <code>check_equals(obtained, expected)</code> macro uses equality 
operator
+       <code>==</code> to check for equality. When possible, use of the
+       <code>check_equals()</code> macro is preferred over <code>check()</code>
+       in that it shows what the obtained result was in case of a mismatch. 
+       DejaGnu.
+      </para>
       
       <para>
        Additionally, the check.as file provides a transparent way to send