Revision: 3959
Author: janne.t.harkonen
Date: Fri Aug 27 03:27:49 2010
Log: Some more docs about the jar distro
http://code.google.com/p/robotframework/source/detail?r=3959
Modified:
/trunk/doc/userguide/src/ExecutingTestCases/BasicUsage.txt
/trunk/doc/userguide/src/ExecutingTestCases/PostProcessing.txt
/trunk/doc/userguide/src/GettingStarted/Installation.txt
/trunk/doc/userguide/src/RobotFrameworkUserGuide.txt
=======================================
--- /trunk/doc/userguide/src/ExecutingTestCases/BasicUsage.txt Fri Aug 27
01:51:24 2010
+++ /trunk/doc/userguide/src/ExecutingTestCases/BasicUsage.txt Fri Aug 27
03:27:49 2010
@@ -40,7 +40,8 @@
Starting from Robot Framework 2.5.2, it is also possible to get Robot
Framework
as a single jar file. In this case, Jython is bundled inside the jar, and
the
-above discussion about Jython applies.
+above discussion about Jython applies. In this case, the normal arguments
to
+Robot Framework are given after the jar file name.
Another possibility for starting the test execution is running the
:prog:`runner.py` script under the installed__ :code:`robot` module
=======================================
--- /trunk/doc/userguide/src/ExecutingTestCases/PostProcessing.txt Thu Aug
26 06:20:51 2010
+++ /trunk/doc/userguide/src/ExecutingTestCases/PostProcessing.txt Fri Aug
27 03:27:49 2010
@@ -51,6 +51,8 @@
java -jar robotframework-<version>.jar rebot
+All normal command line options can be used when executing :prog:`rebot`
from jar.
+
.. Note:: When running tests with Jython, the default JVM maximum
memory size may not be enough for creating reports and logs
if output files are very large. If that happens, you can
=======================================
--- /trunk/doc/userguide/src/GettingStarted/Installation.txt Wed Aug 25
05:43:04 2010
+++ /trunk/doc/userguide/src/GettingStarted/Installation.txt Fri Aug 27
03:27:49 2010
@@ -8,7 +8,7 @@
Introduction
~~~~~~~~~~~~
-There are four ways to install Robot Framework:
+There are several ways to install Robot Framework:
`Installing from source`_
You can get the source code either as a source distribution
@@ -31,9 +31,10 @@
optional Jython_) installed, you can use `One Click Installer`_ to do
all
the needed installations.
-In addition, starting from Robot Framework 2.5.2, Robot Framework is
-distributed as a standalone jar file. In this case, only Java Runtime
-Environment is needed to use Robot Framework.
+`Standalone jar distribution`_
+ If you need to run tests with only Jython, the easiest way to install
everything
+ is to downloading the standalone ``robotframework-<version>.jar``,
which contains
+ both Jython and Robot Framework.
Installation packages are available from
http://downloads.robotframework.org, and source code from
@@ -246,6 +247,27 @@
3. Create the needed runner scripts. If you have a source package or
a checkout, you can get templates from :path:`src/bin` directory.
+Standalone jar distribution
+'''''''''''''''''''''''''''
+
+Starting from Robot Framework 2.5.2, it is also distributed as a standalone
+``robotframework-<version>.jar``, which contains both Jython and Robot
+Framework. It is an easy way to get everything if you do not need to run
tests
+with Python. After you have downloaded the jar file, you can execute it
like::
+
+ java -jar robotframework-2.5.2.jar --help
+ java -jar robotframework-2.5.2.jar mytests.txt
+ java -jar robotframework-2.5.2.jar --variable name:value mytests.txt
+
+If you need to `post-process outputs`_, you need to use :cli:`rebot` as the
+first argument to the jar file::
+
+ java -jar robotframework-2.5.2.jar rebot --help
+ java -jar robotframework-2.5.2.jar rebot output.xml
+ java -jar robotframework-2.5.2.jar rebot --name Combined outputs/*.xml
+
+
+
Where files are installed
'''''''''''''''''''''''''
=======================================
--- /trunk/doc/userguide/src/RobotFrameworkUserGuide.txt Thu Aug 26
06:08:00 2010
+++ /trunk/doc/userguide/src/RobotFrameworkUserGuide.txt Fri Aug 27
03:27:49 2010
@@ -192,6 +192,7 @@
.. _runner script: `Different runner scripts`_
.. _runner scripts: `runner script`_
.. _return code: `return codes`_
+.. _`post-process outputs`: `post-processing outputs`_
.. 4. Extending
