Merge remote-tracking branch 'origin/1.3'

Change-Id: Ib88eb76f360819fbdf2fd52b19fde6d5f5650447

8 files changed, 67 insertions, 44 deletions

diff --git a/doc/doc.pri b/doc/doc.pri
index 30a0c4447..3544962bd 100644
--- a/doc/doc.pri
+++ b/doc/doc.pri
@@ -27,7 +27,14 @@ QHP_FILE = $$OUT_PWD/doc/html/ifw.qhp
 QCH_FILE = $$OUT_PWD/doc/ifw.qch
 
 HELP_DEP_FILES = $$PWD/installerfw.qdoc \
+                 $$PWD/installerfw-getting-started.qdoc \
+                 $$PWD/installerfw-overview.qdoc \
+                 $$PWD/installerfw-reference.qdoc \
+                 $$PWD/installerfw-using.qdoc \
+                 $$PWD/noninteractive.qdoc \
+                 $$PWD/operations.qdoc \
                  $$PWD/scripting.qdoc \
+                 $$PWD/tutorial.qdoc \
                  $$PWD/installerfw.qdocconf \
                  $$PWD/installerfw-online.qdocconf \
                  $$PWD/config/compat.qdocconf \
diff --git a/doc/installerfw-getting-started.qdoc b/doc/installerfw-getting-started.qdoc
index c8bae0514..063ed64c7 100644
--- a/doc/installerfw-getting-started.qdoc
+++ b/doc/installerfw-getting-started.qdoc
@@ -27,9 +27,9 @@
 
 /*!
     \contentspage {index.html}{Qt Installer Framework}
-    \previouspage ifw-use-cases-settings.html
+    \previouspage ifw-overview.html
     \page ifw-getting-started.html
-    \nextpage ifw-tutorial.html
+    \nextpage ifw-use-cases.html
 
     \title Getting Started
 
diff --git a/doc/installerfw-overview.qdoc b/doc/installerfw-overview.qdoc
index 26bcab83d..20ae945e1 100644
--- a/doc/installerfw-overview.qdoc
+++ b/doc/installerfw-overview.qdoc
@@ -29,7 +29,7 @@
     \contentspage {index.html}{Qt Installer Framework}
     \previouspage index.html
     \page ifw-overview.html
-    \nextpage ifw-use-cases.html
+    \nextpage ifw-getting-started.html
 
     \title Overview of Qt Installer Framework
 
diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc
index ca2626b1e..95854d51c 100644
--- a/doc/installerfw-using.qdoc
+++ b/doc/installerfw-using.qdoc
@@ -27,11 +27,11 @@
 
 /*!
     \contentspage {index.html}{Qt Installer Framework}
-    \previouspage ifw-overview.html
+    \previouspage ifw-getting-started.html
     \page ifw-use-cases.html
     \nextpage ifw-use-cases-install.html
 
-    \title Using Installers
+    \title End User Workflows
 
     The end user experience is similar for both offline and online installers.
     The installers consist of a package manager and an updater that enable end
@@ -326,7 +326,7 @@
     \contentspage index.html
     \previouspage ifw-use-cases-update.html
     \page ifw-use-cases-settings.html
-    \nextpage ifw-getting-started.html
+    \nextpage ifw-tutorial.html
 
     \title Specifying Settings
 
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 6386bcc26..c57260e91 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -49,7 +49,8 @@
 
     \list
         \o  \l{Overview of Qt Installer Framework}
-        \o  \l{Using Installers}
+        \o  \l{Getting Started}
+        \o  \l{End User Workflows}
         \list
             \o  \l{Initial Installation}
             \o  \l{Adding Components}
@@ -57,7 +58,6 @@
             \o  \l{Updating Components}
             \o  \l{Specifying Settings}
         \endlist
-        \o  \l{Getting Started}
         \o  \l{Tutorial: Creating an Installer}
         \o  \l{Creating Installers}
         \list
@@ -414,7 +414,7 @@
                 name the version needs to be inherited from.
         \row
             \o  ReleaseDate
-            \o  Date when this component version was released. Optional.
+            \o  Date when this component version was released. Required.
         \row
             \o  Name
             \o  Domain-like identification for this component. Required.
diff --git a/doc/operations.qdoc b/doc/operations.qdoc
index 276b7515a..b187a20cf 100644
--- a/doc/operations.qdoc
+++ b/doc/operations.qdoc
@@ -33,13 +33,12 @@
 
     \title Operations
 
-    You can call operations manually on the uninstaller or installer.
+    The operations are prepared by component scripts and performed by the
+    installer.
 
-    For example, to register the Qt version in Qt Creator, call the
-    "RegisterQtInCreatorV23" operation with the following syntax:
-    \code
-    SDKMaintenanceTool --runoperation "RegisterQtInCreatorV23" "<displayname>" "<qtpath>" "<target: Symbian/Maemo/Desktop/Simulator/WinCE>" "<internal_ID>"
-    \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
 
@@ -81,14 +80,34 @@
             \o  Prepends \a text to the file specified by \a filename. \a text
                 is treated as ASCII text.
         \row
+            \o  Replace
+            \o  "Replace" \a file \a search \ replace
+            \o  Opens \a file to find \a search string and replaces that with the \a replace string.
+        \row
+            \o  LineReplace
+            \o  "LineReplace" \a file \a search \ replace
+            \o  Opens \a file to find lines that start with \a search string and
+                replaces that with the \a replace string.
+        \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]
@@ -151,26 +170,15 @@
                 \a command. Optionally, you can specify \a description,
                 \a contentType, and \a icon. This is currently only supported on
                 Windows.
-        \row
-            \o  RegisterQtInCreatorV2
-            \o  "RegisterQtInCreatorV2", \a displayname, \a qt_or_qmake_path, [\a system_root, [\a sbs_path]].
-            \o  Registers the Qt version \a displayname to Qt Creator with
-                \a qt_or_qmake_path (if the path does not end with the qmake
-                binary, adds \c{bin/qmake} to the path automatically). Optionally,
-                you can specify \a system_root. For Symbian SDKs, Qt Creator
-                finds the Symbian SDK root (EPOCROOT) in the instance root. For
-                Symbian SDKs that support SBS, add \a sbs_path.
-
-                \note Supports Qt Creator 2.2, or later.
-        \row
-            \o  RegisterQtInCreatorV23
-            \o  "RegisterQtInCreatorV23", \a displayname, \a qt_path, \a target, \a internal_id.
-            \o  Registers the Qt version \a displayname to Qt Creator with
-                \a qt_path. \a target is a Qt version in Qt Creator (Symbian,
-                Maemo, Desktop, Qt Simulator, WinCE) and \a internal_id is used
-                to update or remove the Qt version.
-
-                \note Supports Qt Creator 2.3, or later.
     \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 70ecc8ed0..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
 
@@ -250,7 +251,14 @@
             \o  Current platform: \c "x11", \c "win", or \c "mac".
     \endtable
 
-    \note You can use the variables in the parameter list for installation
-    operations. For example, \c{"{TargetDir}/settings.xml"} might be expanded
-    to: \c{"C:/Program Files/My Program/settings.xml"}.
+    The variables can be resolved by calls to \c installer.value(). If embedded
+    in '@' they can also be part of strings passed as arguments to installation
+    operations:
+
+    \code
+    if (installer.value("os") === "win") {
+        component.addOperation("CreateShortcut", "@TargetDir@/MyApp.exe", "@StartMenuDir@/MyApp.lnk");
+    }
+    \endcode
+
 */
diff --git a/doc/tutorial.qdoc b/doc/tutorial.qdoc
index 6f6cae7c3..f4d537e49 100644
--- a/doc/tutorial.qdoc
+++ b/doc/tutorial.qdoc
@@ -27,7 +27,7 @@
 
 /*!
     \contentspage {index.html}{Qt Installer Framework}
-    \previouspage ifw-getting-started.html
+    \previouspage ifw-use-cases-settings.html
     \page ifw-tutorial.html
     \nextpage ifw-creating-installers.html