From 3a08a5f593944711e0449742726bb45c4eac3d85 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 27 Feb 2013 15:58:40 +0100 Subject: Doc: add information about scripting and operations Change-Id: Ic605dad7c3cd4c29034afaab186c88d08d9c4ec1 Reviewed-by: Niels Weber Reviewed-by: Karsten Heimrich Reviewed-by: Tim Jenssen --- doc/operations.qdoc | 19 ++++++++++++++----- doc/scripting.qdoc | 5 +++-- 2 files changed, 17 insertions(+), 7 deletions(-) (limited to 'doc') 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" "" "" - \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" "" "" + \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 -- cgit v1.2.3