/hg/icedtea-web: Update README with information about junit test...

[omajid at icedtea.classpath.org]

changeset e7c791aa1bd2 in /hg/icedtea-web
details: http://icedtea.classpath.org/hg/icedtea-web?cmd=changeset;node=e7c791aa1bd2
author: Omair Majid <omajid at redhat.com>
date: Fri Apr 08 10:17:36 2011 -0400

	Update README with information about junit tests and rhino


diffstat:

 ChangeLog |   4 ++++
 README    |  45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+), 0 deletions(-)

diffs (77 lines):

diff -r 225421c775dd -r e7c791aa1bd2 ChangeLog
--- a/ChangeLog	Thu Apr 07 18:06:40 2011 -0400
+++ b/ChangeLog	Fri Apr 08 10:17:36 2011 -0400
@@ -1,3 +1,7 @@
+2011-04-08  Omair Majid  <omajid at redhat.com>
+
+	* README: Update to add notes on rhino and junit.
+
 2011-04-07  Deepak Bhole <dbhole at redhat.com>
 
 	* plugin/icedteanp/java/sun/applet/PluginAppletViewer.java
diff -r 225421c775dd -r e7c791aa1bd2 README
--- a/README	Thu Apr 07 18:06:40 2011 -0400
+++ b/README	Fri Apr 08 10:17:36 2011 -0400
@@ -66,6 +66,11 @@
 
 The plugin can be disabled by passing --disable-plugin.
 
+The following optional dependencies enable additional features
+
+* rhino (enables support for using proxy auto config files)
+* junit4 (enables unit tests)
+
 See ./configure --help if you need to override the defaults.
 
 The following locations are checked for a JDK:
@@ -113,10 +118,50 @@
 These are documented fully in the relevant section below.
 
 * --disable-plugin: Don't build the browser plugin.
+* --with-rhino: Specify the location of rhino jar
+* --with-junit: Specify the location of the junit 4 jar
+
+Rhino Support
+=============
+
+IcedTea-Web needs rhino for using Proxy Auto Config (PAC) files. If rhino is
+not found, or explicitly disabled, then support for PAC files will be disabled.
+
+By default, the following paths are checked for rhino:
+  - /usr/share/java/js.jar
+  - /usr/share/rhino-1.6/lib/js.jar
+  - /usr/share/java/rhino.jar
+
+If a rhino jar is not found, rhino support is disabled. The --with-rhino build
+option can be used to specify the location of the jar file. To explicitly
+disable rhino use --with-rhino=no.
+
+JUnit Support
+=============
+
+JUnit is needed for running some tests. It has no run-time impact.
+
+By default, the following paths are checked:
+  - /usr/share/java/junit4.jar
+
+If JUnit is not found, JUnit support is disabled. The --with-junit option can
+be used to specify the location of the JUnit 4 jar. To disable JUnit support
+explicitly, use --with-junit=no.
+
+A custom JUnit ouput formatter is supplied. This makes the output of JUnit
+tests match the output of other tests. A simple 'Passed:' or 'FAILED:' is
+printed out, followed by <TestClass>.<testMethod>. This is also the format used
+by JTreg.
 
 Testing
 =======
 
+A set of automated tests is supplied for IcedTea-Web. They can be run by using
+'make check'. Currently, this only tests a few parts of IcedTea-Web.
+
+The number and type of tests run by 'make check' may be affected by the build
+options, including JUnit support and rhino support.
+
 A test suite is supplied for the browser plugin.  It can be built
 using 'make plugin-tests' and run by loading the HTML page specified
 into a browser with the plugin installed.