[Gnash-commit] gnash/doc/C sources.xml [testing-documentation-refactor]

[Ann Barcomb]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         testing-documentation-refactor
Changes by:     Ann Barcomb <ann>       06/12/20 12:56:37

Modified files:
        doc/C          : sources.xml 

Log message:
        Sandro noted that makeswf use has changed due to Dejagnu.swf.
        I have decided to include the make target information only, for the
        sake of simplicity (given that the target audience is users).
        
        I've also subdivided 'Movie tests' and 'ActionScript Unit Tests'.
        I'll probably get rid of these 'sect5' level listings with only one
        paragraph of text once I'm completely clear on the distinctions.
        
        Question: Does the 'make XML-v#.swf' apply to creating tests for
        ActionScript cases as well?  I've treated it as if it does, but haven't
        checked if that's true yet (need to sort out why makeswf isn't found).

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/sources.xml?cvsroot=gnash&only_with_tag=testing-documentation-refactor&r1=1.25.2.5&r2=1.25.2.6

Patches:
Index: sources.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/sources.xml,v
retrieving revision 1.25.2.5
retrieving revision 1.25.2.6
diff -u -b -r1.25.2.5 -r1.25.2.6
--- sources.xml 20 Dec 2006 12:14:07 -0000      1.25.2.5
+++ sources.xml 20 Dec 2006 12:56:37 -0000      1.25.2.6
@@ -1438,41 +1438,42 @@
         </para>  
    
         <para>
-          The first step is to compile the test case.  Ming's
-          <emphasis>makeswf</emphasis> program is used to compile the test
-          case into Flash.  By default, no options are required.
-          Running <emphasis>makeswf</emphasis> looks like this:
+          The first step is to compile the test case, which can be done
+          with 'make XML-v#.swf' where the '#' is replaced with the 
+          <emphasis>target</emphasis> SWF version or versions.  
+          For example:
           <programlisting>
-           shellprompt> makeswf XML.as
-           Output file name: out.swf
-           Output compression level: 9
-           Output SWF version: 6
-           Preprocessing XML.as... done.
-           Compiling `XML.as.pp' into frame 1... done.
-           Saving output to out.swf... done.
-           shellprompt>
+            make XML-v{5,6,7,8}.swf
           </programlisting>
         </para>
    
+        <sect5 id="manual_compiled_tests">
+        <title>Movie tests</title>
         <para>
-          Once you have the flash movie version of the test case, you can
-          run it through the Gnash standalone player with some options
-          which indicate that it is a simple test case.  The unit level
-          tests for ActionScript classes are run without the associated
-          graphics display.
+            This creates a Flash movie version of the test case, which
+            can be run with a standalone Flash player.  For instance,
+            the target for SWF version 6 could be run with Gnash:
           <programlisting>
-            shellprompt> gprocessor -v out.swf
-            PASSED: XML::XML() constructor
-            PASSED: XML::addRequestHeader() exists
-            PASSED: XML::appendChild() exists
-            ...
+              gnash -v XML-v6.swf
           </programlisting>
         </para>
+        </sect5>
+
+        <sect5 id="manual_actionscript_tests">
+          <title>ActionScript Unit Tests</title>
+          <para>
+            Unit tests for ActionScript classes in 'testsuite/actionscript.all'
+            are run without a graphical display:
+            display with:
+            <programlisting>
+              gprocessor -v XML-v6.swf
+            </programlisting>
+          </para>
+        </sect5>
       </sect4>
      </sect3>
   </sect2>
 
-
   <sect2 id="install">
     <title>Installation</title>