Skip to content

Commit f6ef2f6

Browse files
committed
UG: Use '.robot' extension in examples consistently.
1 parent 959169a commit f6ef2f6

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

doc/userguide/src/ExecutingTestCases/BasicUsage.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ __ `Test suite name and documentation`_
6767

6868
::
6969

70-
robot test_cases.html
70+
robot tests.robot
7171
robot path/to/my_tests/
72-
robot c:\robot\tests.txt
72+
robot c:\robot\tests.robot
7373

7474
It is also possible to give paths to several test case files or
7575
directories at once, separated with spaces. In this case, Robot
@@ -83,8 +83,8 @@ often quite long and complicated. In most cases, it is thus better to
8383
use the :option:`--name` option for overriding it, as in the second
8484
example below::
8585

86-
robot my_tests.html your_tests.html
87-
robot --name Example path/to/tests/pattern_*.html
86+
robot my_tests.robot your_tests.robot
87+
robot --name Example path/to/tests/pattern_*.robot
8888

8989
Using command line options
9090
--------------------------
@@ -101,7 +101,7 @@ Using options
101101
When options are used, they must always be given between the runner
102102
script and the data sources. For example::
103103

104-
robot -L debug my_tests.txt
104+
robot -L debug my_tests.robot
105105
robot --include smoke --variable HOST:10.0.0.42 path/to/tests/
106106

107107
Short and long options
@@ -233,7 +233,7 @@ avoid the need to repeat them every time tests are run or ``rebot`` used.
233233
.. sourcecode:: bash
234234

235235
export ROBOT_OPTIONS="--critical regression --tagdoc 'mytag:Example doc with spaces'"
236-
robot tests.txt
236+
robot tests.robot
237237
export REBOT_OPTIONS="--reportbackground green:yellow:red"
238238
rebot --name example output.xml
239239

@@ -345,7 +345,7 @@ Example below illustrates how errors and warnings look like in the log file.
345345
<tr>
346346
<td class="time">20090322&nbsp;19:58:42.528</td>
347347
<td class="error level">ERROR</td>
348-
<td class="msg">Error in file '/home/robot/tests.html' in table 'Setting' in element on row 2: Resource file 'resource.html' does not exist</td>
348+
<td class="msg">Error in file '/home/robot/tests.robot' in table 'Setting' in element on row 2: Resource file 'resource.robot' does not exist</td>
349349
</tr>
350350
<tr>
351351
<td class="time">20090322&nbsp;19:58:43.931</td>
@@ -464,10 +464,10 @@ option was. This means that options in argument files can override options
464464
before it, and its options can be overridden by options after it. It is possible
465465
to use :option:`--argumentfile` option multiple times or even recursively::
466466

467-
robot --argumentfile all_arguments.txt
468-
robot --name Example --argumentfile other_options_and_paths.txt
469-
robot --argumentfile default_options.txt --name Example my_tests.html
470-
robot -A first.txt -A second.txt -A third.txt tests.txt
467+
robot --argumentfile all_arguments.robot
468+
robot --name Example --argumentfile other_options_and_paths.robot
469+
robot --argumentfile default_options.txt --name Example my_tests.robot
470+
robot -A first.txt -A second.txt -A third.txt tests.robot
471471

472472
Reading argument files from standard input
473473
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -477,7 +477,7 @@ standard input stream instead of a file. This can be useful when generating
477477
arguments with a script::
478478

479479
generate_arguments.sh | robot --argumentfile STDIN
480-
generate_arguments.sh | robot --name Example --argumentfile STDIN tests.txt
480+
generate_arguments.sh | robot --name Example --argumentfile STDIN tests.robot
481481

482482
Getting help and version information
483483
------------------------------------
@@ -606,7 +606,7 @@ outputs are very big. There are several ways to configure JVM options:
606606
script that will pass them forward to Java. This is especially easy when
607607
using `direct entry points`_::
608608

609-
jython -J-Xmx1024m -m robot.run some_tests.txt
609+
jython -J-Xmx1024m -m robot some_tests.robot
610610

611611
Debugging problems
612612
------------------

doc/userguide/src/ExecutingTestCases/ConfiguringExecution.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,11 +209,11 @@ when `post-processing outputs`_ with ``rebot``, you need to
209209
use :option:`--critical` and/or :option:`--noncritical` also with it::
210210

211211
# Use rebot to create new log and report from the output created during execution
212-
robot --critical regression --outputdir all my_tests.html
212+
robot --critical regression --outputdir all tests.robot
213213
rebot --name Smoke --include smoke --critical regression --outputdir smoke all/output.xml
214214

215215
# No need to use --critical/--noncritical when no log or report is created
216-
robot --log NONE --report NONE my_tests.html
216+
robot --log NONE --report NONE tests.robot
217217
rebot --critical feature1 output.xml
218218

219219
__ `By tag names`_
@@ -439,7 +439,7 @@ what was randomized and what seed was used.
439439

440440
Examples::
441441

442-
robot --randomize tests my_test.txt
442+
robot --randomize tests my_test.robot
443443
robot --randomize all:12345 path/to/tests
444444

445445
__ `Free test suite metadata`_

doc/userguide/src/ExecutingTestCases/OutputFiles.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ the extension and the base name of each file. The example below would,
172172
for example, create such output files as
173173
:file:`output-20080604-163225.xml` and :file:`mylog-20080604-163225.html`::
174174

175-
robot --timestampoutputs --log mylog.html --report NONE tests.html
175+
robot --timestampoutputs --log mylog.html --report NONE tests.robot
176176

177177
Setting titles
178178
~~~~~~~~~~~~~~
@@ -501,9 +501,9 @@ or warnings`__ are not removed except when using the `ALL` mode.
501501
Examples::
502502

503503
rebot --removekeywords all --output removed.xml output.xml
504-
robot --removekeywords passed --removekeywords for tests.txt
505-
robot --removekeywords name:HugeKeyword --removekeywords name:resource.* tests.txt
506-
robot --removekeywords tag:huge tests.txt
504+
robot --removekeywords passed --removekeywords for tests.robot
505+
robot --removekeywords name:HugeKeyword --removekeywords name:resource.* tests.robot
506+
robot --removekeywords tag:huge tests.robot
507507

508508
Removing keywords is done after parsing the `output file`_ and generating
509509
an internal model based on it. Thus it does not reduce memory usage as much
@@ -543,7 +543,7 @@ supports the following modes:
543543

544544
Examples::
545545

546-
robot --flattenkeywords name:HugeKeyword --flattenkeywords name:resource.* tests.txt
546+
robot --flattenkeywords name:HugeKeyword --flattenkeywords name:resource.* tests.robot
547547
rebot --flattenkeywords foritem --output flattened.xml original.xml
548548

549549
Flattening keywords is done already when the `output file`_ is parsed

0 commit comments

Comments
 (0)