summaryrefslogtreecommitdiffstats
path: root/doc/operations.qdoc
diff options
context:
space:
mode:
authorTim Jenssen <tim.jenssen@digia.com>2013-02-27 12:43:48 +0100
committerTim Jenssen <tim.jenssen@digia.com>2013-02-27 12:46:42 +0100
commitb312d841f0da08e83c8ce9062d8c55adb6cdfdeb (patch)
tree098939e18949988d373bab550e4f4388cc00c68d /doc/operations.qdoc
parent3a79600ec8bf643d9bd059a5047251a2316977d3 (diff)
add some doc to execute operation case
Change-Id: I76fffbc3b8a4e7659443f3de218642993cacba92 Reviewed-by: Niels Weber <niels.weber@digia.com>
Diffstat (limited to 'doc/operations.qdoc')
-rw-r--r--doc/operations.qdoc17
1 files changed, 14 insertions, 3 deletions
diff --git a/doc/operations.qdoc b/doc/operations.qdoc
index 4a1c00bcf..83e467319 100644
--- a/doc/operations.qdoc
+++ b/doc/operations.qdoc
@@ -81,13 +81,24 @@
is treated as ASCII text.
\row
\o Execute
- \o "Execute" [{\a exitcodes}] \a command [\a parameter1 [\a parameter2 [\a parameter3 [\a parameter4]]]]
- \o Executes the command specified by \a command. Up to four
- parameters can be passed.
+ \o "Execute" [{\a exitcodes}] \a command [\a parameter1 [\a parameter... [\a parameter10]]]
+ \o Executes the command specified by \a command. Up to 10
+ parameters can be passed. If that is not enough, you can use a JavaScript string array.
Optionally, you can pass a comma-separated list of exit codes
within curly brackets ({}) as the first argument to specify the
exit codes for successful execution. This defaults to "{0}".
+
+ Other optional named arguments are: "workingdirectory=<your_working_dir>";
+ "errormessage=<your_custom_errormessage>"
+
+ In addition, a special argument, UNDOEXECUTE, separates the DO step of the operation
+ from the UNDO step.
+
+ example:
+ \code
+ component.addOperation("Execute", "touch", "test.txt", "UNDOEXECUTE", "rm", "test.txt")
+ \endcode
\row
\o CreateShortcut
\o "CreateShortcut" \a filename \a linkname [\a arguments]