Add support for generating offline installer from online

Task-number: QTIFW-1945
Change-Id: Ic8a076a28385e99ad09cfbccd07c7012d6570639
Reviewed-by: Katja Marttila <katja.marttila@qt.io>

3 files changed, 49 insertions, 0 deletions

diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc
index cb0e4d3ad..d4f4b6688 100644
--- a/doc/installerfw-using.qdoc
+++ b/doc/installerfw-using.qdoc
@@ -470,6 +470,20 @@
     maintenancetool.exe purge
     \endcode
 
+    \section1 Creating Custom Offline Installers
+
+    To create a personal offline installer containing a selected set of components from online repositories,
+    use the \c create-offline command. This is a useful feature for scenarios where the same installation
+    content will be deployed multiple times or on several machines, as it saves time spent on downloading
+    component archives and enables easily reproducible installations. The \c --offline-installer-name
+    option can be used to set a desired name for the generated offline installer.
+
+    Note that you can create offline installers only from online installers with valid repositories enabled.
+
+    \code
+    installer.exe --root "C:\TargetFolder" --offline-installer-name "MyInstaller" create-offline componentA componentB
+    \endcode
+
     \section1 Unattended Usage
 
     By default, the generated installers may ask for additional information during installation,
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index ebc1e2044..ef7479a33 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -223,6 +223,10 @@
             \li -t, --root <directory>
             \li [CLI] Set the installation root directory.
         \row
+            \li --oi, --offline-installer-name <filename>
+            \li [CLI] Set custom filename for the generated offline installer. Without this
+                the original filename is used with an added "_offline-yyyy-MM-dd" suffix.
+        \row
             \li -p, --platform <plugin>
             \li Use the specified platform plugin.
         \row
@@ -316,6 +320,9 @@
             \li se, search <regexp>
             \li Search available packages. If no search pattern is given, show all available packages.
         \row
+            \li co, create-offline <pkg ...>
+            \li Create offline installer from selected packages.
+        \row
             \li pr, purge
             \li Uninstall all packages and remove the program directory.
     \endtable
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc
index 74b430d2f..8a9d297a0 100644
--- a/doc/scripting-api/packagemanagercore.qdoc
+++ b/doc/scripting-api/packagemanagercore.qdoc
@@ -211,6 +211,22 @@
 */
 
 /*!
+    \qmlsignal installer::offlineGenerationStarted()
+
+    Triggered when offline installer generation has started.
+
+    \sa offlineGenerationFinished()
+*/
+
+/*!
+    \qmlsignal installer::offlineGenerationFinished
+
+    Triggered when offline installer generation has finished.
+
+    \sa offlineGenerationStarted()
+*/
+
+/*!
     \qmlsignal installer::titleMessageChanged(string title)
 
     Emitted when the text of the installer status (on the PerformInstallation page) changes to
@@ -832,6 +848,12 @@
 */
 
 /*!
+    \qmlmethod boolean installer::isOfflineGenerator()
+
+    Returns \c true if the application is executed in offline generation mode.
+*/
+
+/*!
     \qmlmethod boolean installer::isUserSetBinaryMarker()
 
     Returns \c true if the magic binary marker has been set by user.
@@ -868,6 +890,12 @@
 */
 
 /*!
+    \qmlmethod boolean installer::runOfflineGenerator()
+
+    Runs the offline generator. Returns \c true on success, \c false otherwise.
+*/
+
+/*!
     \qmlmethod void installer::languageChanged()
 
     Calls languangeChanged on all components.