[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash/doc/C internals.xml sources.xml [testing-documentat
|
From: |
Ann Barcomb |
|
Subject: |
[Gnash-commit] gnash/doc/C internals.xml sources.xml [testing-documentation-refactor] |
|
Date: |
Wed, 20 Dec 2006 11:10:53 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Branch: testing-documentation-refactor
Changes by: Ann Barcomb <ann> 06/12/20 11:10:53
Modified files:
doc/C : internals.xml sources.xml
Log message:
Sandro wrote:
Due to the target audience, I belive this whole chapter should be
moved under the 'building gnash' section. Builders are likely the
ones that will run testcases as after install there will be no
testcases accessible (except the online ones, for which we could still
leave a pointer in the documentation).
I agree with his suggestion, and have moved the 'running tests'
section in to a different part of the documentation.
Note that this commit is on the development branch.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/internals.xml?cvsroot=gnash&only_with_tag=testing-documentation-refactor&r1=1.47.2.1&r2=1.47.2.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/sources.xml?cvsroot=gnash&only_with_tag=testing-documentation-refactor&r1=1.25&r2=1.25.2.1
Patches:
Index: internals.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/internals.xml,v
retrieving revision 1.47.2.1
retrieving revision 1.47.2.2
diff -u -b -r1.47.2.1 -r1.47.2.2
--- internals.xml 19 Dec 2006 15:46:29 -0000 1.47.2.1
+++ internals.xml 20 Dec 2006 11:10:53 -0000 1.47.2.2
@@ -1905,103 +1905,11 @@
<sect2 id="testing">
<title>Testing</title>
- <sect3 id="runtests">
- <title>Running Tests</title>
-
- <para>
- Gnash users are encouraged to run the test suite and report
- failing tests to the development team.
- </para>
-
-<!--
- <para>
- If a test fails, please report it by following the
- <link linkend="bugreport">instructions for reporting a bug</link>.
- </para>
--->
-
- <sect4 id="dejagnu">
- <title>Using DejaGnu</title>
- <para>
- The easiest way to run Gnash's test suite is to install
- <emphasis>
- <ulink type="http"
-
url="http://www.gnu.org/software/dejagnu";>DejaGnu</ulink></emphasis>.
- After installing DejaGnu, change to the
- <emphasis>testsuite</emphasis> directory and run:
- <programlisting>
- make check
- </programlisting>
- </para>
-
- <para>
- If you encounter a problem with a test, increasing the
- verbosity may make the issue easier to spot.
- Additional details are visible when
- <emphasis>RUNTESTFLAGS</emphasis> are used to add the
- <emphasis>verbose</emphasis> and <emphasis>all</emphasis> options.
- Verbose prints more information about the testing process, while
- all includes details on passing tests.
- <programlisting>
- make check RUNTESTFLAGS="-v -a"
- </programlisting>
- </para>
-
<para>
- It is possible to run just a particular test, or group of tests,
- by specifying the directory or compiled test file. For instance,
- the following runs the 'clip_as_button2-TestRunner' test from
- the top source directory:
- <programlisting>
- make -C testsuite/samples/clip_as_button2-TestRunner check
- </programlisting>
+ <link linkend="runtests">Instructions on running tests</link>
+ can be found in the section on building Gnash.
</para>
- </sect4>
- <sect4 id="manually">
- <title>Running The Tests Manually</title>
-
- <para>
- You may also run test cases by hand, which can be useful if you
- want to see all the debugging output from the test case. Often
- the messages which come from deep within Gnash are most useful for
- development.
- </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:
- <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>
- </programlisting>
- </para>
-
- <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.
- <programlisting>
- shellprompt> gprocessor -v out.swf
- PASSED: XML::XML() constructor
- PASSED: XML::addRequestHeader() exists
- PASSED: XML::appendChild() exists
- ...
- </programlisting>
- </para>
- </sect4>
- </sect3>
-
<sect3 id="writing_tests">
<title>Writing Tests</title>
Index: sources.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/sources.xml,v
retrieving revision 1.25
retrieving revision 1.25.2.1
diff -u -b -r1.25 -r1.25.2.1
--- sources.xml 11 Dec 2006 11:28:46 -0000 1.25
+++ sources.xml 20 Dec 2006 11:10:53 -0000 1.25.2.1
@@ -1348,8 +1348,100 @@
sub directory of <emphasis>apidoc/html</emphasis>
</para>
</sect3>
+
+ <sect3 id="runtests">
+ <title>Running the Tests</title>
+
+<!--
+ <para>
+ If a test fails, please report it by following the
+ <link linkend="bugreport">instructions for reporting a bug</link>.
+ </para>
+-->
+
+ <sect4 id="dejagnu">
+ <title>Using DejaGnu</title>
+ <para>
+ The easiest way to run Gnash's test suite is to install
+ <emphasis><ulink type="http"
+ url="http://www.gnu.org/software/dejagnu";>DejaGnu</ulink></emphasis>.
+ After installing DejaGnu, change to the
+ <emphasis>testsuite</emphasis> directory and run:
+ <programlisting>
+ make check
+ </programlisting>
+ </para>
+
+ <para>
+ If you encounter a problem with a test, increasing the
+ verbosity may make the issue easier to spot.
+ Additional details are visible when
+ <emphasis>RUNTESTFLAGS</emphasis> are used to add the
+ <emphasis>verbose</emphasis> and <emphasis>all</emphasis> options.
+ Verbose prints more information about the testing process, while
+ all includes details on passing tests.
+ <programlisting>
+ make check RUNTESTFLAGS="-v -a"
+ </programlisting>
+ </para>
+
+ <para>
+ It is possible to run just a particular test, or group of tests,
+ by specifying the directory or compiled test file. For instance,
+ the following runs the 'clip_as_button2-TestRunner' test from
+ the top source directory:
+ <programlisting>
+ make -C testsuite/samples/clip_as_button2-TestRunner check
+ </programlisting>
+ </para>
+
+ </sect4>
+ <sect4 id="manually">
+ <title>Running The Tests Manually</title>
+
+ <para>
+ You may also run test cases by hand, which can be useful if you
+ want to see all the debugging output from the test case. Often
+ the messages which come from deep within Gnash are most useful for
+ development.
+ </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:
+ <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>
+ </programlisting>
+ </para>
+
+ <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.
+ <programlisting>
+ shellprompt> gprocessor -v out.swf
+ PASSED: XML::XML() constructor
+ PASSED: XML::addRequestHeader() exists
+ PASSED: XML::appendChild() exists
+ ...
+ </programlisting>
+ </para>
+ </sect4>
+ </sect3>
</sect2>
+
<sect2 id="install">
<title>Installation</title>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash/doc/C internals.xml sources.xml [testing-documentation-refactor],
Ann Barcomb <=