diff options
| author | Katja Marttila <katja.marttila@qt.io> | 2020-12-20 11:31:30 +0200 |
|---|---|---|
| committer | Katja Marttila <katja.marttila@qt.io> | 2020-12-22 08:38:36 +0200 |
| commit | a606c9915b8ff1d6001a83aa350400d6286706ff (patch) | |
| tree | 33fba20f96caf98be8d42382763d0f93f92a9366 /doc | |
| parent | b7df5571e0707f53716fa51d426d5ec31d36af43 (diff) | |
Introduce ForcedUpdate element for component
Setting ForcedUpdate for component will cause a mandatory update for
component if it is installed. Component must be updated before any other
component can be updated/installed/removed. Essential components are updated
at the same time with ForcedUpdate.
Task-number: QTIFW-1565
Change-Id: I6af07fba222371e8cd161d1fec65301450077d86
Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/examples/package.xml | 1 | ||||
| -rw-r--r-- | doc/installerfw-using.qdoc | 8 | ||||
| -rw-r--r-- | doc/installerfw.qdoc | 6 | ||||
| -rw-r--r-- | doc/scripting-api/component.qdoc | 8 |
4 files changed, 20 insertions, 3 deletions
diff --git a/doc/examples/package.xml b/doc/examples/package.xml index 4248a7e83..16b9e07ce 100644 --- a/doc/examples/package.xml +++ b/doc/examples/package.xml @@ -26,6 +26,7 @@ <UpdateText>This changed compared to the last release</UpdateText> <Default>false</Default> <ForcedInstallation>false</ForcedInstallation> + <ForcedUpdate>false</ForcedUpdate> <Essential>false</Essential> <Replaces>com.vendor.root.component2old</Replaces> <Operations> diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc index 89c3351ee..cb0e4d3ad 100644 --- a/doc/installerfw-using.qdoc +++ b/doc/installerfw-using.qdoc @@ -419,9 +419,11 @@ \section1 Updating Components Running \c update without arguments will update all components that have an update - available. Essential components are always updated first, same way as it is done when - launching updater from GUI. To update only a specific subset of installed components, - they can be provided as an optional argument for \c update: + available. Essential and ForcedUpdate components are always updated first, same way as + when launching the updater from GUI. After Essential and ForcedUpdate components + are updated, the installer needs to be restarted for other updates. To update only + a specific subset of installed components, they can be provided as an optional argument + for \c update: \code maintenancetool.exe update componentA componentB diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index 22407e17d..d5335d585 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -895,6 +895,12 @@ \li Determines that the package must always be installed. End users cannot deselect it in the installer. \row + \li ForcedUpdate + \li Marks the package as \c ForcedUpdate to force a restart of the + \c MaintenanceTool. If there are updates available + for a \c ForcedUpdate component, the package manager stays + disabled until that component is updated. + \row \li Replaces \li Comma-separated list of components to replace. Optional. diff --git a/doc/scripting-api/component.qdoc b/doc/scripting-api/component.qdoc index c7a9509c8..ffa2988a3 100644 --- a/doc/scripting-api/component.qdoc +++ b/doc/scripting-api/component.qdoc @@ -421,6 +421,14 @@ */ /*! + \qmlmethod boolean component::isForcedUpdate() + + Returns \c true if the component is installed and has a \c ForcedUpdate flag set. + Forced updates will be updated together with essential components before any + other component can be updated or installed. +*/ + +/*! \qmlmethod void component::setUninstalled() Sets the component state to uninstalled. |