summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2013-02-27 15:58:40 +0100
committerTim Jenssen <tim.jenssen@digia.com>2013-02-28 13:23:33 +0100
commit3a08a5f593944711e0449742726bb45c4eac3d85 (patch)
treea6f0bbb7473031a895d5c73285cc879fb6b6b5e5
parent5df05c0a9cef3a041d9c5dd8b5838712759a8e5e (diff)
Doc: add information about scripting and operations
Change-Id: Ic605dad7c3cd4c29034afaab186c88d08d9c4ec1 Reviewed-by: Niels Weber <niels.weber@digia.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com> Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
-rw-r--r--doc/operations.qdoc19
-rw-r--r--doc/scripting.qdoc5
2 files changed, 17 insertions, 7 deletions
diff --git a/doc/operations.qdoc b/doc/operations.qdoc
index 46880bbc5..b187a20cf 100644
--- a/doc/operations.qdoc
+++ b/doc/operations.qdoc
@@ -33,12 +33,12 @@
\title Operations
- You can test operations manually on the uninstaller or installer.
+ The operations are prepared by component scripts and performed by the
+ installer.
- For example, to copy a file:
- \code
- SDKMaintenanceTool --runoperation "Copy" "<source>" "<target>"
- \endcode
+ Internally, each operation has a \e DO step that contains instructions for
+ the installer and an \e UNDO step that contains instructions for the
+ uninstaller.
\section1 Summary of Operations
@@ -172,4 +172,13 @@
Windows.
\endtable
+ If errors occur, you can test operations manually on the uninstaller or
+ installer. However, variables are not resolved, so you need to use absolute
+ values.
+
+ For example, to test copying a file:
+ \code
+ Installer --runoperation "Copy" "<source>" "<target>"
+ \endcode
+
*/
diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc
index 3bfe1a2b7..410e1645a 100644
--- a/doc/scripting.qdoc
+++ b/doc/scripting.qdoc
@@ -33,8 +33,9 @@
\title Component Scripting
- For each component, you can specify one script that is loaded and run by the
- installer. The script format has to be compatible with QScriptEngine.
+ For each component, you can specify one script that prepares the operations
+ to be performed by the installer. The script format has to be
+ compatible with QScriptEngine.
\section1 Construction