Revision: a148674e3cec
Branch: default
Author: Pekka Klärck
Date: Tue Jun 17 05:07:50 2014 UTC
Log: UG: Enhanced docs or --remove/flattenkeywords and fixed example.
http://code.google.com/p/robotframework/source/detail?r=a148674e3cec
Modified:
/doc/userguide/RobotFrameworkUserGuide.html
/doc/userguide/src/ExecutingTestCases/OutputFiles.rst
=======================================
--- /doc/userguide/RobotFrameworkUserGuide.html Mon Jun 16 23:14:29 2014 UTC
+++ /doc/userguide/RobotFrameworkUserGuide.html Tue Jun 17 05:07:50 2014 UTC
@@ -12154,8 +12154,9 @@
<p>In these situations, command line options <span
class="opt">--removekeywords</span> and
<span class="opt">--flattenkeywords</span> can be used to dispose or
flatten unnecessary keywords.
They can be used both when <a class="reference internal"
href="#executing-test-cases">executing test cases</a> and when <a
class="reference internal" href="#post-processing-outputs">post-processing
-outputs</a>, but in the former case they only affect the log file, not the
XML
-output file.</p>
+outputs</a>. When used during execution, they only affect the log file, not
+the XML output file. With <span class="code">rebot</span> they affect both
logs and possibly
+generated new output XML files.</p>
<div class="section" id="removing-keywords">
<h4><a class="toc-backref" href="#id661">Removing keywords</a></h4>
<p>The <span class="opt">--removekeywords</span> option removes keywords
and their messages
@@ -12184,7 +12185,7 @@
</dl>
<p>Examples:</p>
<pre class="literal-block">
-rebot --removekeywords all output.xml
+rebot --removekeywords all --output removed.xml output.xml
pybot --removekeywords passed --removekeywords for tests.txt
pybot --removekeywords name:HugeKeyword --removekeywords name:resource.*
tests.txt
</pre>
@@ -12220,11 +12221,11 @@
<p>Examples:</p>
<pre class="literal-block">
pybot --flattenkeywords name:HugeKeyword --flattenkeywords name:resource.*
tests.txt
-rebot --flattenkeywords foritem tests.txt
+rebot --flattenkeywords foritem --output flattened.xml original.xml
</pre>
-<p>Flattening keywords is done already when the <a class="reference
internal" href="#output-file">output file</a> is parsed. This
-can save a significant amount of memory especially with deeply nested
-keyword structures.</p>
+<p>Flattening keywords is done already when the <a class="reference
internal" href="#output-file">output file</a> is parsed
+initially. This can save a significant amount of memory especially with
+deeply nested keyword structures.</p>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">Flattening keywords is a new feature in Robot Framework
2.8.2, and
@@ -17982,7 +17983,7 @@
<div class="footer">
<hr class="footer" />
<p>Generated by <a class="reference external"
href="http://docutils.sourceforge.net/rst.html";>reStructuredText</a>.
Syntax highlighting by <a class="reference external"
href="http://pygments.org/";>Pygments</a>.</p>
-<p>Generated on: 2014-06-16 23:14 UTC.
+<p>Generated on: 2014-06-17 05:07 UTC.
</p>
</div>
=======================================
--- /doc/userguide/src/ExecutingTestCases/OutputFiles.rst Mon Jun 16
23:14:11 2014 UTC
+++ /doc/userguide/src/ExecutingTestCases/OutputFiles.rst Tue Jun 17
05:07:50 2014 UTC
@@ -455,8 +455,9 @@
In these situations, command line options :opt:`--removekeywords` and
:opt:`--flattenkeywords` can be used to dispose or flatten unnecessary
keywords.
They can be used both when `executing test cases`_ and when
`post-processing
-outputs`_, but in the former case they only affect the log file, not the
XML
-output file.
+outputs`_. When used during execution, they only affect the log file, not
+the XML output file. With :code:`rebot` they affect both logs and possibly
+generated new output XML files.
Removing keywords
'''''''''''''''''
@@ -491,7 +492,7 @@
Examples::
- rebot --removekeywords all output.xml
+ rebot --removekeywords all --output removed.xml output.xml
pybot --removekeywords passed --removekeywords for tests.txt
pybot --removekeywords name:HugeKeyword --removekeywords
name:resource.* tests.txt
@@ -526,11 +527,11 @@
Examples::
pybot --flattenkeywords name:HugeKeyword --flattenkeywords
name:resource.* tests.txt
- rebot --flattenkeywords foritem tests.txt
+ rebot --flattenkeywords foritem --output flattened.xml original.xml
-Flattening keywords is done already when the `output file`_ is parsed. This
-can save a significant amount of memory especially with deeply nested
-keyword structures.
+Flattening keywords is done already when the `output file`_ is parsed
+initially. This can save a significant amount of memory especially with
+deeply nested keyword structures.
.. note:: Flattening keywords is a new feature in Robot Framework 2.8.2,
and
:opt:`FOR` and :opt:`FORITEM` modes were added in Robot Framework
--
---
You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to robotframework-commit+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
