Author: laukpe
Date: Tue Nov 25 00:30:02 2008
New Revision: 1097
Modified:
trunk/doc/userguide/src/Appendices/CommandLineOptions.txt
trunk/doc/userguide/src/CreatingTestData/Variables.txt
trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
trunk/doc/userguide/src/ExtendingRobotFramework/ListenerInterface.txt
Log:
show cli var file args in some more examples, minor style changes
Modified: trunk/doc/userguide/src/Appendices/CommandLineOptions.txt
==============================================================================
--- trunk/doc/userguide/src/Appendices/CommandLineOptions.txt (original)
+++ trunk/doc/userguide/src/Appendices/CommandLineOptions.txt Tue Nov 25
00:30:02 2008
@@ -25,9 +25,9 @@
-e, --exclude <tag> `Selects the test cases`_ by tag.
-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.
- -v, --variable <name:value> `Sets individual variables`_ in the test
data.
- -V, --variablefile <path> Sets variables using `variable files`_.
+ --runmode <mode> Sets the `execution mode`_ for this test run.
+ -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`_.
-o, --output <file> Sets the path to the generated `output file`_.
-l, --log <file> Sets the path to the generated `log file`_.
@@ -112,9 +112,8 @@
.. _Selects the test cases: `By tag names`_
.. _considered critical: `Setting criticality`_
.. _not critical: `considered critical`_
-.. _Sets the execution mode: `Setting the execution mode`_
-.. _Sets individual variables: `Setting variables`_
-.. _read variables: `Sets individual variables`_
+.. _execution mode: `Setting the execution mode`_
+.. _individual variables: `Setting variables in command line`_
.. _create output files: `Output directory`_
.. _Adds a timestamp: `Timestamping output files`_
Modified: trunk/doc/userguide/src/CreatingTestData/Variables.txt
==============================================================================
--- trunk/doc/userguide/src/CreatingTestData/Variables.txt (original)
+++ trunk/doc/userguide/src/CreatingTestData/Variables.txt Tue Nov 25
00:30:02 2008
@@ -356,8 +356,8 @@
'''''''''''''''''''''''''''''''''
Variables can be set from the command line either individually with
-the :opt:`--variable` option or using a variable file with the
-:opt:`--variablefile` option. Variables set from the command line
+the :opt:`--variable (-v)` option or using a variable file with the
+:opt:`--variablefile (-V)` option. Variables set from the command line
are globally available for all executed test data files, and they also
override possible variables with the same names in the Variable table and
in
variable files imported in the test data.
Modified:
trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
==============================================================================
--- trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
(original)
+++ trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt Tue
Nov 25 00:30:02 2008
@@ -285,6 +285,7 @@
--variable name:value
--variable OS:Linux --variable IP:10.0.0.42
--variablefile path/to/variables.py
+ --variablefile myvars.py:possible:arguments:here
--variable ENVIRONMENT:Windows --variablefile c:\resources\windows.py
__ `Setting variables in command line`_
Modified:
trunk/doc/userguide/src/ExtendingRobotFramework/ListenerInterface.txt
==============================================================================
--- trunk/doc/userguide/src/ExtendingRobotFramework/ListenerInterface.txt
(original)
+++ trunk/doc/userguide/src/ExtendingRobotFramework/ListenerInterface.txt
Tue Nov 25 00:30:02 2008
@@ -178,7 +178,7 @@
writes all the information it gets into a text file in a temporary
directory
without much formatting. The filename may be given from the command line,
but
also has a default value. Note that in real usage, the `debug file`_
-functionality available through the command line option :cli:`--debugfile`
is
+functionality available through the command line option :opt:`--debugfile`
is
probably more useful than this example.
.. sourcecode:: python
