From 9c8de2b298a3a5e599e558834c5f341015417604 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Thu, 21 Feb 2013 13:56:28 +0100 Subject: Doc: Show all .qdoc files in Qt Creator Change-Id: If0816dffa8055bdaa1169423dd1d41c747777d43 Reviewed-by: Leena Miettinen --- doc/doc.pri | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc') 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 \ -- cgit v1.2.3 From 9bc52b6f5645ed9cc8471a9d666e6bc6cd11a2de Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Thu, 21 Feb 2013 14:04:08 +0100 Subject: Doc: Rename "Using Installer" section to "End User Workflows" "Using Installer" is ambiguous to me since it's not clear that this is really about the _end_ user, not the developer. Change-Id: Iac9389d87ebd43ee0338bc471d8052acb2469ad3 Reviewed-by: Leena Miettinen --- doc/installerfw-using.qdoc | 2 +- doc/installerfw.qdoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc index ca2626b1e..f8acc4193 100644 --- a/doc/installerfw-using.qdoc +++ b/doc/installerfw-using.qdoc @@ -31,7 +31,7 @@ \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 diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index 6386bcc26..9d63bb5b9 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -49,7 +49,7 @@ \list \o \l{Overview of Qt Installer Framework} - \o \l{Using Installers} + \o \l{End User Workflows} \list \o \l{Initial Installation} \o \l{Adding Components} -- cgit v1.2.3 From ec65b0cb3c329d211e26fe76afc906cfdf0c8e21 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Thu, 21 Feb 2013 14:10:01 +0100 Subject: Doc: Move "Getting Started" section up Change-Id: I6ce46933a9b398d4eef734c175d15f108997b441 Reviewed-by: Leena Miettinen --- doc/installerfw-getting-started.qdoc | 4 ++-- doc/installerfw-overview.qdoc | 2 +- doc/installerfw-using.qdoc | 4 ++-- doc/installerfw.qdoc | 2 +- doc/tutorial.qdoc | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) (limited to 'doc') 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 f8acc4193..95854d51c 100644 --- a/doc/installerfw-using.qdoc +++ b/doc/installerfw-using.qdoc @@ -27,7 +27,7 @@ /*! \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 @@ -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 9d63bb5b9..df1cac518 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -49,6 +49,7 @@ \list \o \l{Overview of Qt Installer Framework} + \o \l{Getting Started} \o \l{End User Workflows} \list \o \l{Initial Installation} @@ -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 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 -- cgit v1.2.3 From 27b5200b2468e20a1e258e5758e32008bd83cdc4 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Tue, 26 Feb 2013 11:31:03 +0100 Subject: Doc: Mark 'ReleaseDate' property as required Task-number: QTIFW-223 Change-Id: Ic4ac3d32f4754294dcd12a309a3a86db9a6ff578 Reviewed-by: Niels Weber --- doc/installerfw.qdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index df1cac518..c57260e91 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -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. -- cgit v1.2.3 From af28535bbf48fd232e21b19ffb4be87bbea8b9e6 Mon Sep 17 00:00:00 2001 From: Tim Jenssen Date: Wed, 27 Feb 2013 10:08:39 +0100 Subject: remove doc for already removed operations Change-Id: I023bb17ca0c385a46ca8d654b877457e2ba58d42 Reviewed-by: Niels Weber --- doc/operations.qdoc | 20 -------------------- 1 file changed, 20 deletions(-) (limited to 'doc') diff --git a/doc/operations.qdoc b/doc/operations.qdoc index 276b7515a..26f5ac855 100644 --- a/doc/operations.qdoc +++ b/doc/operations.qdoc @@ -151,26 +151,6 @@ \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 */ -- cgit v1.2.3 From 3a79600ec8bf643d9bd059a5047251a2316977d3 Mon Sep 17 00:00:00 2001 From: Tim Jenssen Date: Wed, 27 Feb 2013 12:20:11 +0100 Subject: change test operation example to Copy The RegisterQtInCreatorV23 was removed. Change-Id: Ib91ac95cd2896aebc1c41e4eac3051e5c1a4e5b2 Reviewed-by: Niels Weber --- doc/operations.qdoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/operations.qdoc b/doc/operations.qdoc index 26f5ac855..4a1c00bcf 100644 --- a/doc/operations.qdoc +++ b/doc/operations.qdoc @@ -33,12 +33,11 @@ \title Operations - You can call operations manually on the uninstaller or installer. + You can test operations manually on the uninstaller or installer. - For example, to register the Qt version in Qt Creator, call the - "RegisterQtInCreatorV23" operation with the following syntax: + For example, to copy a file: \code - SDKMaintenanceTool --runoperation "RegisterQtInCreatorV23" "" "" "" "" + SDKMaintenanceTool --runoperation "Copy" "" "" \endcode \section1 Summary of Operations -- cgit v1.2.3 From b312d841f0da08e83c8ce9062d8c55adb6cdfdeb Mon Sep 17 00:00:00 2001 From: Tim Jenssen Date: Wed, 27 Feb 2013 12:43:48 +0100 Subject: add some doc to execute operation case Change-Id: I76fffbc3b8a4e7659443f3de218642993cacba92 Reviewed-by: Niels Weber --- doc/operations.qdoc | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'doc') 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="; + "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] -- cgit v1.2.3 From 7627f4cb189c1e94c78bc64d5affaa632a0e3fcc Mon Sep 17 00:00:00 2001 From: Tim Jenssen Date: Wed, 27 Feb 2013 12:21:47 +0100 Subject: add replace operations doc Change-Id: I3b2ffca803bf720f7ca6f443d10dee44db189739 Reviewed-by: Niels Weber --- doc/operations.qdoc | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'doc') diff --git a/doc/operations.qdoc b/doc/operations.qdoc index 83e467319..46880bbc5 100644 --- a/doc/operations.qdoc +++ b/doc/operations.qdoc @@ -79,6 +79,15 @@ \o "PrependFile" \a filename \a text \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 parameter... [\a parameter10]]] -- cgit v1.2.3 From 5df05c0a9cef3a041d9c5dd8b5838712759a8e5e Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Tue, 26 Feb 2013 16:14:41 +0100 Subject: Doc: Fix documentation on predefined variables Change-Id: I805a07f007cddb9fe62db986968f9f79511ffe1f Reviewed-by: Tim Jenssen Reviewed-by: Leena Miettinen --- doc/scripting.qdoc | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc index 70ecc8ed0..3bfe1a2b7 100644 --- a/doc/scripting.qdoc +++ b/doc/scripting.qdoc @@ -250,7 +250,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 + */ -- cgit v1.2.3 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