Revision: 3267
Author: pekka.klarck
Date: Wed May 12 00:31:03 2010
Log: cleanup
http://code.google.com/p/robotframework/source/detail?r=3267
Modified:
/trunk/doc/userguide/src/Appendices/CommandLineOptions.txt
/trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
/trunk/doc/userguide/src/ExecutingTestCases/TestExecution.txt
=======================================
--- /trunk/doc/userguide/src/Appendices/CommandLineOptions.txt Mon May 10
04:20:32 2010
+++ /trunk/doc/userguide/src/Appendices/CommandLineOptions.txt Wed May 12
00:31:03 2010
@@ -11,7 +11,6 @@
:depth: 2
:local:
-
Command line options for test execution
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -26,6 +25,8 @@
-c, --critical <tag> Tests that have the given tag are `considered
critical`_.
-n, --noncritical <tag> Tests that have the given tag are `not
critical`_.
--runmode <mode> Sets the `execution mode`_ for this test run.
+ Valid modes are :opt:`ContinueOnFailure`,
+ :opt:`DryRun`, and :opt:`Random:<what>`.
-v, --variable <name:value> Sets `individual variables`_.
-V, --variablefile <path:args> Sets variables using `variable files`_.
-d, --outputdir <dir> Defines where to `create output files`_.
@@ -59,7 +60,6 @@
-h, --help Prints `usage instructions`_.
--version Prints the `version information`_.
-
Command line options for post-processing outputs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,7 +112,7 @@
.. _Selects the test cases: `By tag names`_
.. _considered critical: `Setting criticality`_
.. _not critical: `considered critical`_
-.. _execution mode: `Setting the execution mode`_
+.. _execution mode: `Setting execution mode`_
.. _individual variables: `Setting variables in command line`_
.. _create output files: `Output directory`_
=======================================
--- /trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
Wed May 12 00:20:08 2010
+++ /trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
Wed May 12 00:31:03 2010
@@ -12,7 +12,6 @@
:depth: 2
:local:
-
Selecting test cases
~~~~~~~~~~~~~~~~~~~~
@@ -20,7 +19,6 @@
which test cases to execute. The same options also work when
post-processing outputs with the :prog:`rebot` tool.
-
By test suite and test case names
'''''''''''''''''''''''''''''''''
@@ -113,7 +111,6 @@
the tests for a certain iteration can be generated (for
example, :cli:`rebot
--include iter-42 ouput.xml`).
-
Setting criticality
~~~~~~~~~~~~~~~~~~~
@@ -160,7 +157,6 @@
__ `By tag names`_
__ http://code.google.com/p/robotframework/issues/detail?id=146
-
Setting metadata
~~~~~~~~~~~~~~~~
@@ -187,7 +183,6 @@
__ `Test suite name and documentation`_
-
Setting free metadata
'''''''''''''''''''''
@@ -206,7 +201,6 @@
the given tag to all executed test cases. This option may be used
several times to set multiple tags.
-
Adjusting library search path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -227,7 +221,6 @@
__ `Setting listeners`_
__ `Creating start-up scripts`_
-
Locations automatically in PYTHONPATH
'''''''''''''''''''''''''''''''''''''
@@ -240,9 +233,8 @@
__ `Packaging libraries`_
-
-Setting PYTHONPATH in system
-''''''''''''''''''''''''''''
+Setting PYTHONPATH
+''''''''''''''''''
There are several ways to alter PYTHONPATH in the system, but the most
common one is setting an environment variable with the same name
@@ -251,9 +243,8 @@
locations listed in it are added into the library search path
regardless the interpreter.
-
-Setting CLASSPATH in the system
-'''''''''''''''''''''''''''''''
+Setting CLASSPATH
+'''''''''''''''''
CLASSPATH is used only with Jython, and the most common way to alter
it is setting an environment variable similarly as with PYTHONPATH.
@@ -261,9 +252,8 @@
PYTHONPATH with Jython, even with libraries and listeners implemented
with Java.
-
-Using the --pythonpath option
-'''''''''''''''''''''''''''''
+Using --pythonpath option
+'''''''''''''''''''''''''
Robot Framework also has a separate command line option
:opt:`--pythonpath (-P)` for adding directories or archives into
@@ -280,7 +270,6 @@
--pythonpath /opt/testlibs:mylibs.zip:yourlibs
--pythonpath mylib.jar --pythonpath lib/STAR.jar --escape star:STAR
-
Setting variables
~~~~~~~~~~~~~~~~~
@@ -298,9 +287,8 @@
__ `Setting variables in command line`_
-
-Setting the execution mode
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+Setting execution mode
+~~~~~~~~~~~~~~~~~~~~~~
Exit on failure
'''''''''''''''
@@ -316,6 +304,27 @@
__ `Stopping test execution gracefully`_
+Dry run
+'''''''
+
+Robot Framework supports so called *dry run* mode where the tests are
+run normally otherwise, but the keywords coming from test libraries
+are not executed at all. The dry rum mode can be used to validate the
+test data; if the dry run passes, the data should be syntactically
+correct. This mode is triggered using option :opt:`--runmode DryRun`
+(case-insensitive) and it is supported starting from Robot Framework
+2.5.
+
+The dry run execution may fail for following reasons:
+
+ * Using keywords that are not found.
+ * Using keywords with wrong number of arguments.
+ * Using user keywords that have invalid syntax.
+
+In addition, normal `execution errors`__ are shown, for example, when
+test library or resource file imports cannot be resolved.
+
+__ `Errors and warnings during execution`_
Randomizing execution order
'''''''''''''''''''''''''''
@@ -340,29 +349,6 @@
pybot --runmode random:test my_test.txt
-
-Dry run
-'''''''
-
-Robot Framework supports so called *dry run* mode where the tests are
-run normally otherwise, but the keywords coming from test libraries are
-not executed at all. This mode can be used to validate the test data;
-if the dry run passes, the data should be syntactically correct. The
-dry run execution may fail for following reasons:
-
- * Using keywords that are not found.
- * Using keywords with wrong number of arguments.
- * Using user keywords that have invalid syntax.
-
-In addition, normal `execution errors`__ are shown, for example, when
-test library or resource file imports cannot be resolved.
-
-This mode is triggered using option :opt:`--runmode DryRun`
(case-insensitive)
-and it is supported starting from Robot Framework 2.5.
-
-__ `Errors and warnings during execution`_
-
-
Controlling the monitor output
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -391,7 +377,6 @@
pybot --monitorwidth 140 --monitorcolors OFF tests.html > output.txt
-
Setting listeners
~~~~~~~~~~~~~~~~~
=======================================
--- /trunk/doc/userguide/src/ExecutingTestCases/TestExecution.txt Mon May
10 03:29:01 2010
+++ /trunk/doc/userguide/src/ExecutingTestCases/TestExecution.txt Wed May
12 00:31:03 2010
@@ -104,7 +104,7 @@
files nicely one file per line. It is also possible to `randomize the
execution
order of test cases or test suites`__ using :opt:`--runmode` option.
-__ `Setting the execution mode`_
+__ `Setting execution mode`_
Continue on failure
