Skip to content

Commit 0885b4e

Browse files
pekkaklarckpekkaklarck
committed
Doc tuning.
- Fixed link in UG introduced by PR robotframework#2117. - Slitting lines etc. minor changes related to the same PR. - Removed references to removed --runfailed and --rerunmerge - Mention in CLI usage that -X is new in 3.1.
1 parent ceff6d3 commit 0885b4e

4 files changed

Lines changed: 17 additions & 17 deletions

File tree

‎doc/userguide/src/Appendices/CommandLineOptions.rst‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,10 @@ Command line options for test execution
1919
-G, --settag <tag> `Sets the tag(s)`_ to all executed test cases.
2020
-t, --test <name> `Selects the test cases by name`_.
2121
-s, --suite <name> `Selects the test suites`_ by name.
22-
-R, --rerunfailed <file> `Selects failed tests`_ from an earlier `output file`_ to be re-executed.
23-
--runfailed <file> Deprecated since Robot Framework 2.8.4.
24-
Use :option:`--rerunfailed` instead.
25-
-S, --rerunfailedsuites <file> `Selects failed test suite`_ from an earlier `output file`_ to be re-executed.
26-
22+
-R, --rerunfailed <file> `Selects failed tests`_ from an earlier `output file`_
23+
to be re-executed.
24+
-S, --rerunfailedsuites <file> `Selects failed test suites`_ from an earlier
25+
`output file`_ to be re-executed.
2726
-i, --include <tag> `Selects the test cases`_ by tag.
2827
-e, --exclude <tag> `Selects the test cases`_ by tag.
2928
-c, --critical <tag> Tests that have the given tag are `considered critical`_.
@@ -90,8 +89,6 @@ Command line options for post-processing outputs
9089
------------------------------------------------
9190

9291
-R, --merge Changes result combining behavior to `merging <merging outputs_>`__.
93-
--rerunmerge Deprecated since Robot Framework 2.8.6.
94-
Use :option:`--merge` instead.
9592
-N, --name <name> `Sets the name`_ of the top level test suite.
9693
-D, --doc <document> `Sets the documentation`_ of the top-level test suite.
9794
-M, --metadata <name:value> `Sets free metadata`_ for the top-level test suite.
@@ -150,7 +147,7 @@ Command line options for post-processing outputs
150147
.. _Sets the tag(s): `Setting tags`_
151148
.. _Selects the test cases by name: `By test suite and test case names`_
152149
.. _Selects the test suites: `Selects the test cases by name`_
153-
.. _Selects failed tests suites: `Re-executing failed test suites`_
150+
.. _Selects failed test suites: `Re-executing failed test suites`_
154151
.. _Selects failed tests: `Re-executing failed test cases`_
155152
.. _Selects the test cases: `By tag names`_
156153
.. _considered critical: `Setting criticality`_

‎doc/userguide/src/ExecutingTestCases/ConfiguringExecution.rst‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,15 @@ __ `Merging outputs`_
142142

143143
Re-executing failed test suites
144144
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145-
Command line option :option:`rerunfailedsuites (-S)` can be used to select all failed
146-
suites from an earlier `output file`_ for re-execution. Like :option:`--rerunfailed (-R)`, this option is useful when
147-
full test execution takes a lot of time. Note that all tests from a failed test suite will be re-executed, even
148-
passing ones. This option is useful when the tests of a test suite depends on each other.
149145

150-
Behind the scenes this option selects the failed suite as they would have been
146+
Command line option :option:`rerunfailedsuites (-S)` can be used to select all
147+
failed suites from an earlier `output file`_ for re-execution. Like
148+
:option:`--rerunfailed (-R)`, this option is useful when full test execution
149+
takes a lot of time. Note that all tests from a failed test suite will be
150+
re-executed, even passing ones. This option is useful when the tests in
151+
a test suite depends on each other.
152+
153+
Behind the scenes this option selects the failed suites as they would have been
151154
selected individually with the :option:`--suite` option. It is possible to further
152155
fine-tune the list of selected tests by using :option:`--test`, :option:`--suite`,
153156
:option:`--include` and :option:`--exclude` options.

‎doc/userguide/src/ExecutingTestCases/PostProcessing.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ There is often a need to re-execute a subset of tests, for example, after
127127
fixing a bug in the system under test or in the tests themselves. This can be
128128
accomplished by `selecting test cases`_ by names (:option:`--test` and
129129
:option:`--suite` options), tags (:option:`--include` and :option:`--exclude`),
130-
or by previous status (:option:`--rerunfailed` or :option: `--rerunfailedsuites`).
130+
or by previous status (:option:`--rerunfailed` or :option:`--rerunfailedsuites`).
131131

132132
Combining re-execution results with the original results using the default
133133
`combining outputs`_ approach does not work too well. The main problem is
@@ -152,8 +152,7 @@ section.
152152

153153
.. note:: Merging re-executed results is a new feature in Robot Framework 2.8.4.
154154
Prior to Robot Framework 2.8.6 new tests or suites in merged outputs
155-
were skipped and merging was done using nowadays deprecated
156-
:option:`--rerunmerge` option.
155+
were skipped and merging was done using :option:`--rerunmerge` option.
157156

158157
Merging suites executed in pieces
159158
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎src/robot/run.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126
re-executed. Equivalent to selecting same tests
127127
individually using --test option.
128128
-S --rerunfailedsuites output Select failed suite from an earlier output file
129-
to be re-executed (New in RF 3.0.1).
129+
to be re-executed. New in RF 3.0.1.
130130
-c --critical tag * Tests having given tag are considered critical. If no
131131
critical tags are set, all tags are critical. Tags
132132
can be given as a pattern like with --include.
@@ -286,6 +286,7 @@
286286
--dryrun Verifies test data and runs tests so that library
287287
keywords are not executed.
288288
-X --exitonfailure Stops test execution if any critical test fails.
289+
Short option -X is new in RF 3.0.1.
289290
--exitonerror Stops test execution if any error occurs when parsing
290291
test data, importing libraries, and so on.
291292
--skipteardownonexit Causes teardowns to be skipped if test execution is

0 commit comments

Comments
 (0)