[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash ChangeLog doc/C/internals.xml doc/C/sourc...
|
From: |
Ann Barcomb |
|
Subject: |
[Gnash-commit] gnash ChangeLog doc/C/internals.xml doc/C/sourc... |
|
Date: |
Mon, 22 Jan 2007 07:12:54 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Ann Barcomb <ann> 07/01/22 07:12:54
Modified files:
. : ChangeLog
doc/C : internals.xml sources.xml
Log message:
Partially merged branch 'testing-documentation-refactor' for
files doc/C/sources.xml and doc/C/internals.xml. The change
involved moving 'running tests' from the test-writing section
into the user's installation section.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.2142&r2=1.2143
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/internals.xml?cvsroot=gnash&r1=1.53&r2=1.54
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/sources.xml?cvsroot=gnash&r1=1.26&r2=1.27
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.2142
retrieving revision 1.2143
diff -u -b -r1.2142 -r1.2143
--- ChangeLog 19 Jan 2007 15:46:50 -0000 1.2142
+++ ChangeLog 22 Jan 2007 07:12:53 -0000 1.2143
@@ -1,3 +1,10 @@
+2007-01-22 Ann Barcomb <address@hidden>
+
+ * Partially merged branch 'testing-documentation-refactor' for
+ files doc/C/sources.xml and doc/C/internals.xml. The change
+ involved moving 'running tests' from the test-writing section
+ into the user's installation section.
+
2007-01-19 Sandro Santilli <address@hidden>
* server/asobj/xmlnode.cpp (attachXMLNodeInterface):
Index: doc/C/internals.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/internals.xml,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -b -r1.53 -r1.54
--- doc/C/internals.xml 3 Jan 2007 17:18:07 -0000 1.53
+++ doc/C/internals.xml 22 Jan 2007 07:12:53 -0000 1.54
@@ -1253,7 +1253,12 @@
</sect2>
<sect2 id="testing">
- <title>Testing Support</title>
+ <title>Testing </title>
+
+ <para>
+ <link linkend="runtests">Instructions on running tests</link>
+ can be found in the section on building Gnash.
+ </para>
<sect3 id="testtools">
<title>Testing Tools</title>
@@ -1795,88 +1800,6 @@
</sect3>
- <sect3 id="runtests">
- <title>Running The Tests</title>
-
- <sect4 id="dejagnu">
- <title>Using DejaGnu</title>
-
- <para>
- The simple way to run the tests is to install
- <emphasis>DejaGnu</emphasis>, and use that to run the tests. That
- handles all the details to compile and execute the tests. To
- run the tests using DejaGnu, change to the
- <emphasis>testsuite</emphasis> directory and type:
- <programlisting>
- make check
- </programlisting>
- </para>
-
- <para>
- You can get more details by adding command line option when
- invoking <emphasis>make</emphasis>. The <emphasis>make
check</emphasis> target
- in the Makefile supports a variable, <emphasis>RUNTESTFLAGS</emphasis>
- that gets passed to DejaGnu when it's invoked by
<emphasis>make</emphasis>.
-
- <programlisting>
- make check RUNTESTFLAGS="-v -a"
- </programlisting>
-
- This adds the <emphasis>verbose (-v)</emphasis> option and the
- <emphasis>all (-a)</emphasis> option. Verbose prints much more
- information about how DejaGnu is running the test. It may be
- too much information, but if you think you are having a
- problem with running a test case, this is a good way to track
- it down. The <emphasis>all</emphasis> option tells DejaGnu to print
- all the tests that <emphasis>PASS</emphasis>, as well as those that
- <emphasis>FAIL</emphasis>.
- </para>
- </sect4>
-
- <sect4 id="manually">
- <title>Manually Running Tests</title>
-
- <para>
- You can also run all the test cases by hand, which is useful
- if you want to see all the debug output from the test
- case. Often the debug messages which come deep from within
- Gnash are the most useful during 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.
- </programlisting>
- </para>
-
- <para>
- Once you have the flash movie version of the test case, you
- can run it through the Gnash standalone player with a few
- options which enable a simple test cases to be run. The
- unit level tests for an ActionScript class are run without
- an associated graphics display.
- </para>
- <programlisting>
- shellprompt> gprocessor -v out.swf
- PASSED: XML::XML() constructor
- PASSED: XML::addRequestHeader() exists
- PASSED: XML::appendChild() exists
- ...
- </programlisting>
-
- </sect4>
- </sect3>
</sect2>
</sect1>
Index: doc/C/sources.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/sources.xml,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -b -r1.26 -r1.27
--- doc/C/sources.xml 21 Jan 2007 22:41:02 -0000 1.26
+++ doc/C/sources.xml 22 Jan 2007 07:12:53 -0000 1.27
@@ -1,8 +1,27 @@
<sect1 id="build">
<title>Building From Source</title>
+ <sect2 id="building_overview">
+ <title>Overview</title>
<para>
+ The typical process of building from source will involve
+ <link linkend="codedepend">resolving dependencies</link>,
+ <link linkend="configure">configuration</link>,
+ <link linkend="compile">compilation</link>,
+ <link linkend="runtests">testing</link>, and
+ <link linkend="install">installation</link>.
+ A simplified overview of the process would be:
+ <programlisting>
+ ./autogen.sh
+ ./configure
+ make
+ make check
+ make install
+ </programlisting>
+ Continue reading for detailed step-by-step instructions
+ of the entire procedure.
</para>
+ </sect2>
<sect2 id="codedepend">
<title>Code Dependencies</title>
@@ -1240,11 +1259,11 @@
<variablelist>
<varlistentry>
- <term>--build</term>
+ <term>--target</term>
<listitem>
<para>
- The build architecture. This is the architecture the
- development tools we're using are supposed to run on.
+ The target architecture. This is the architecture the
+ final executables are supposed to run on.
</para>
</listitem>
</varlistentry>
@@ -1253,7 +1272,21 @@
<listitem>
<para>
The host architecture. This is the architecture the
- executables are supposed to run on.
+ executables are supposed to run on. This is usually the
+ same as <emphasis>--target</emphasis> except when building a
+ compiler as a
+ Canadian Cross. This is when you build a cross
+ compiler on a Unix machine, that runs on a
+ <emphasis>win32</emphasis> machine, producing code for yet
+ a third architecture, like the <emphasis>ARM</emphasis>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>--build</term>
+ <listitem>
+ <para>
+ This is the system this build is running on.
</para>
</listitem>
</varlistentry>
@@ -1334,6 +1367,122 @@
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>
+ FIXME: Add a section on running tests without DejaGnu.
+ 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, run:
+ <programlisting>
+ make check
+ </programlisting>
+ </para>
+
+ <sect5 id="testing_verbosity">
+ <title>Increasing Verbosity</title>
+ <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>
+ </sect5>
+
+ <sect5 id="running_some_tests">
+ <title>Running Some Tests</title>
+ <para>
+ It is possible to run just a particular test, or
+ subdirectory of tests, by specifying the directory or
+ compiled test file.
+ </para>
+ <para>
+ Some tests rely on <emphasis>testsuite/Dejagnu.swf</emphasis>,
+ which in turn relies on <emphasis>Ming</emphasis>.
+ This file is created when you run 'make check' for the entire
+ testsuite, and can also be created on demand:
+ <programlisting>
+ make -C testsuite Dejagnu.swf
+ </programlisting>
+ </para>
+ <para>
+ In this example, the 'clip_as_button2' test is compiled and
+ run:
+ <programlisting>
+ make -C testsuite/samples clip_as_button2-TestRunner
+ cd testsuite/samples && ./clip_as_button2-TestRunner
+ </programlisting>
+ This would create and run all the tests in the directory
+ 'movies.all':
+ <programlisting>
+ make -C testsuite/movies.all check
+ </programlisting>
+ </para>
+ </sect5>
+
+ </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, 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>
+ make XML-v{5,6,7,8}.swf
+ </programlisting>
+ </para>
+
+ <sect5 id="manual_compiled_tests">
+ <title>Movie tests</title>
+ <para>
+ 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>
+ 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:
+ <programlisting>
+ gprocessor -v XML-v6.swf
+ </programlisting>
+ </para>
+ </sect5>
+ </sect4>
+ </sect3>
</sect2>
<sect2 id="install">
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash ChangeLog doc/C/internals.xml doc/C/sourc...,
Ann Barcomb <=