Revision: 3569d8fa202d
Author: Robot Framework Developers <[email protected]>
Date: Tue Jan 24 04:50:52 2012
Log: tidy: doc tuning
http://code.google.com/p/robotframework/source/detail?r=3569d8fa202d
Modified:
/doc/userguide/src/SupportingTools/SupportingTools.txt
/src/robot/tidy.py
=======================================
--- /doc/userguide/src/SupportingTools/SupportingTools.txt Tue Jan 24
04:28:56 2012
+++ /doc/userguide/src/SupportingTools/SupportingTools.txt Tue Jan 24
04:50:52 2012
@@ -9,8 +9,11 @@
Test data clean-up tool (:prog:`tidy`)
--------------------------------------
-:prog:`tidy` is a tool for cleaning up and changing the format of Robot
Framework
-test data files. By default, the output is written to the standard output
+:prog:`tidy` is a tool for cleaning up and changing the format of Robot
+Framework test data files. It is built-in into Robot Framework and
+automatically included in the installation starting from version 2.7.
+
+By default, the output of the tool is written into the standard output
stream, but it can also be redirected to a file. Alternatively, files can
be
modified in-place using :opt:`--inplace` or :opt:`--recursive` options.
@@ -89,6 +92,7 @@
and just have the :path:`robot` directory with the source code somewhere
in your system.
+
Test data editing tool (RIDE)
-----------------------------
=======================================
--- /src/robot/tidy.py Tue Jan 24 03:38:38 2012
+++ /src/robot/tidy.py Tue Jan 24 04:50:52 2012
@@ -26,15 +26,13 @@
but it can be redirected to a file. Alternatively, files can be modified
in-place using --inplace or --recursive options.
-All output files are written using UTF-8 encoding. Outputs written to the
-console use the current console encoding.
-
Options:
-i --inplace Tidy given file(s) so that original file(s) are
overwritten
(or removed, if the format is changed). When this option
is
- used, it is possible to give multiple input files.
Examples:
- python -m robot.tidy --inplace tests.html
- python -m robot.tidy --inplace --format txt *.html
+ used, it is possible to give multiple input files.
+ Examples:
+ python -m robot.tidy --inplace tests.html
+ python -m robot.tidy --inplace --format txt *.html
-r --recursive Process given directory recursively. Files in the
directory
are processed in place similarly as when --inplace option
is
used.
@@ -55,8 +53,8 @@
python -m robot.tidy messed_up_tests.html > cleaned_tests.html
python -m robot.tidy --inplace tests.txt
-Changing test data format
-=========================
+Changing the test data format
+=============================
Robot Framework supports test data in HTML, TSV and TXT formats and this
tool
makes changing between the formats trivial. Input format is always
determined
@@ -66,6 +64,19 @@
Examples:
python -m robot.tidy --format tsv tests_in_html.html > tests_in_tsv.tsv
python -m robot.tidy --format txt --recursive mytests
+
+Output encoding
+===============
+
+All output files are written using UTF-8 encoding. Outputs written to the
+console use the current console encoding.
+
+Alternative execution
+=====================
+
+In the above examples tidy is used only with Python, but it works also with
+Jython and IronPython. Above tidy is executed as an installed module, but
+it can also be executed as a script like `python path/robot/tidy.py`.
"""
import os
@@ -181,7 +192,7 @@
if output:
console(output)
except DataError, err:
- console('%s\n\n%sUse --help for usage.' % unicode(err))
+ console('%s\n\nUse --help for usage.' % unicode(err))
sys.exit(1)
except Information, msg:
console(unicode(msg))
