summaryrefslogtreecommitdiffstats
path: root/doc/installerfw.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* macOS: make creating maintenance tool alias optionalArttu Tarkiainen2022-06-031-1/+1
| | | | | | | | | | | | | | | | Currently the installer will create an alias file for maintenance tool with the name defaulting to the file name of maintenance tool, if the name is not explicitly declared in the installer's configuration file. This can cause issues with installers that use the same maintenance tool filename, as the alias would be overwritten on each install, and the default name does not tell which installation the alias is associated with. Make it so that the alias is only created if installer config specifies a name for the alias. Task-number: QTIFW-2665 Change-Id: I790ee376ec56cff16730189e513a194b8c610066 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Fix updating autodependency componentsKatja Marttila2022-05-131-2/+3
| | | | | | | | | | | Autodependency components were always forcely updated, even if 'Deselect All' was selected in component selection page. Fixed so that the autodependency component update is updated only when one of its dependants is updated. Task-number: QTIFW-2595 Change-Id: I05ececc45ef32ff80d53b008f839b358158a3316 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* macOS: Create alias of maintenance tool to Applications directoryArttu Tarkiainen2022-05-051-0/+4
| | | | | | | | | | | | This makes maintenance tool startable from Launchpad and Spotlight search. Add "MaintenanceToolAlias" configuration variable for setting the name of the alias, which may differ from the actual file name in installation directory. Task-number: QTIFW-2535 Task-number: QTIFW-2478 Change-Id: I73ae5bbf5d0196b2512b5517cb02c391b2ab278c Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add option for specifying maximum concurrent unpack operationsArttu Tarkiainen2022-04-211-0/+6
| | | | | | | | | | For tracing issues with the multithreaded extraction and limiting the processor load from the installer. Task-number: QTIFW-2586 Change-Id: I5df0bf6be30b4ee5ef8470c407281e2a4318ed0c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Doc: add reference of metadata formats supported by repogenArttu Tarkiainen2022-03-311-0/+12
| | | | | | Change-Id: Ie36c8fdad257b08e8a6238f5460fd2de15682253 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Doc: Add instructions for promoting maintenance tool updatesArttu Tarkiainen2022-03-311-0/+101
| | | | | | | Task-number: QTIFW-2440 Change-Id: Ia34524072d7e1e7ca321d4e0ba4013ce4fc012a0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add click option for product imageKatja Marttila2022-03-211-1/+6
| | | | | | | | | | Product image can now be clicked. It opens either url in Web browser or if file reference is given, then it will be opened with the suitable application. Task-number: QTIFW-2361 Change-Id: I59ed1355e90c23c8d0a5124779725825ca1ee2c8 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Update license headerKatja Marttila2022-01-241-2/+2
| | | | | | | Use https instead of http in www.qt.io/licensing Change-Id: I0a2e97afcda03d50fd823be8e11426c2399a3b8f Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Doc: note the expected image file format for customization elementsArttu Tarkiainen2022-01-171-6/+6
| | | | | | | Task-number: QTIFW-2426 Change-Id: I56ff521c928110977dc6a094d066bcee5145607d Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Merge remote-tracking branch 'origin/4.0'Arttu Tarkiainen2022-01-131-7/+6
|\ | | | | | | Change-Id: Ifb02b022312859c2c946ec0debcd77dc90a0ced2
| * Doc: Note the unique name requirement for files referred in config.xmlArttu Tarkiainen2020-12-211-0/+4
| | | | | | | | | | | | | | Task-number: QTIFW-2077 Change-Id: Ie5a21cb73dc41135e20e5059644d22c31275b49d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
| * Doc: Mark <InstallerWindowIcon> as Linux and Windows only elementArttu Tarkiainen2020-12-101-0/+1
| | | | | | | | | | | | Task-number: QTIFW-2077 Change-Id: I0298f2a3ec2eeb74536d27c172b9e84527bddf80 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
| * Remove references to <Icon> elementArttu Tarkiainen2020-12-101-7/+1
| | | | | | | | | | | | | | | | | | | | The element is marked as deprecated and does not work correctly anymore so mentions should be removed from documentation and code accordingly. Replaced with <InstallerApplicationIcon> and <InstallerWindowIcon>. Task-number: QTIFW-2076 Change-Id: I33c60321e468852b6ae20b44ed72a3e7a2119b75 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Add support for moving child components with <TreeName>Arttu Tarkiainen2022-01-061-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add new optional "moveChildren" attribute to <TreeName> element. Children of components declaring "moveChildren=true" attribute are calculated a value for an automatic tree name element. Multiple components in a single tree branch can declare a tree name, the order which the relocation happens is from leaf components to root components. Components may be moved under another tree name target. Components may be moved to an existing identifier part that does not have a component, for example in the following repository structure: rootA.childA rootB rootB.childB the "rootB" component can legally declare a "rootA" tree name. The tree names of components become static after installed. If a repository declares a new tree name for a component that is installed, it is only applied after updating in maintenance tool. Child components, which have an automatic tree name, are moved if the parent component is updated with a new tree name, however. Task-number: QTIFW-2380 Change-Id: I9c44a114d3c1248b7e2dd4f0b5cda0739af102f3 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Libarchive: enable support for uncompressed tar archivesArttu Tarkiainen2021-12-091-2/+3
| | | | | | | | | | | | | | Task-number: QTIFW-2404 Change-Id: I4c62d283d54a1f180f9c3525da0728a1c75ef50e Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Doc: Note the expected translation name format in package dir referenceArttu Tarkiainen2021-09-161-2/+4
| | | | | | | | | | | | Change-Id: I66c5c83a3df29b7c5926277270979d7cf933be6c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | binarycreator: support selecting compression level and archive formatArttu Tarkiainen2021-09-141-0/+19
| | | | | | | | | | | | Task-number: QTIFW-1587 Change-Id: I8855b1ce4bb8abf072ff235846428fc63729f0fb Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | repogen: add support for setting compression level for data archivesArttu Tarkiainen2021-09-141-0/+13
| | | | | | | | | | | | Task-number: QTIFW-1587 Change-Id: I86c4b08eb43e3cafbab83e04961c51d6bdbc98ba Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Add support for handling archive files with libarchiveArttu Tarkiainen2021-09-141-7/+58
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | libarchive is a multi-format archive and compression library written in C and licensed under the new BSD license. Usage of libarchive brings in support for additional archive formats (in addition to 7z) with the installer framework, like zip and tar, with several available compression methods like gzip, bzip2 and xz. libarchive will coexist as a supported archive format handler with the LZMA SDK currently used in the framework, which will continue to be used for handling the 7-Zip file format. This change introduces classes for handling archive operations using both libraries, removes most calls to the old Lib7z facade and migrates the code base to use the new handling methods. Task-number: QTIFW-2255 Change-Id: I8d77110ded503060495a3d6fdfdbc26281df9453 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Merge remote-tracking branch 'origin/4.1'Arttu Tarkiainen2021-06-021-3/+23
|\ \ | | | | | | | | | Change-Id: I86049138466399411ba36791330f4a94faad8c52
| * | Add documentation for translation usageKatja Marttila2021-05-071-3/+23
| | | | | | | | | | | | | | | | | | | | | Task-number: QTIFW-2217 Change-Id: I15af0ac81842db386bb8d86b4a76bdd45722b4a9 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* | | CLI: Add support for additional filtering of search resultsArttu Tarkiainen2021-04-091-1/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Search command results can now be optionally filtered with the '--filter-packages'-option, which takes an unspecified count of key-value pairs that contain the desired package information element and a regular expression used to find matches in the element. Example usage: 'installer --fp "Version=1.0, Description=Some text" search *' Only the packages which match all given filter rules are included in the output print. Task-number: QTIFW-2168 Change-Id: I788b065d95952b988489c36db80b3c859b970f05 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | | Add alternative way to update components from repositoryKatja Marttila2021-03-031-0/+5
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | Components can be updated from online repository using version number. Sometimes there is a need to update to an older version which is now possible by using content sha. Content sha can be added to repository with repogen --sha-update <component_id>. If there is a new content sha available in the repository, component is updated although it version number might be smaller. After the content sha is removed from online repository, the normal update with version number is performed. Task-number: QTIFW-1798 Change-Id: Id9e32b0345af5101cccaf6e30c81bd39691d9590 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* | Fix documentation for package directory nameKatja Marttila2021-02-191-1/+3
| | | | | | | | | | | | | | | | | | | | Package directory name cannot contain characters ':' or '-' as those are used as a separator for version number. This information was not found clear enough in the documentation. Task-number: QTIFW-2146 Change-Id: Id291cf821f35b7ef5b6d720c94b46f2e83c9d6d9 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Documentation fixesKatja Marttila2021-02-191-1/+1
| | | | | | | | | | | | Change-Id: Ibb8da857319eff6119b0296375b6c38578729559 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Add possibility to move component in component treeKatja Marttila2021-02-111-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | Setting <TreeName> -tag to component.xml will overwrite the default location of component in installer's tree view. This way we can define the component location without a complete repo build. Updates.xml can be directly modified by adding <TreeName> -tag for easy relocation of components. TreeName must be an unique name - it cannot conflict with existing tree name or name. Task-number: QTIFW-594 Change-Id: Ie69f90f1303d932369d566d0d7b4bc0e354505c6 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* | Doc: Remove obsolete \contentspage commandLeena Miettinen2021-02-041-11/+0
| | | | | | | | | | Change-Id: Ief8fe530fcca22ea7dbe4baf66b2a2bc837ce1af Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Add support for setting minimum wizard dimensions in config.xmlArttu Tarkiainen2021-02-041-0/+8
| | | | | | | | | | | | | | Task-number: QTIFW-1903 Change-Id: I4d8eaf71a1a63dfbfa75ea61af728fa1f5e3e9f3 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Add support for generating offline installer from onlineArttu Tarkiainen2021-01-151-0/+7
| | | | | | | | | | | | Task-number: QTIFW-1945 Change-Id: Ic8a076a28385e99ad09cfbccd07c7012d6570639 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Fix translating from component scriptKatja Marttila2021-01-141-6/+1
| | | | | | | | | | | | | | | | | | Translate using QCoreApplication::translate instead of QObject::tr. Removed the use of obsolete installTranslatorFunctions() function. Task-number: QTIFW-392 Change-Id: Icdd67efb6889acd26d63297fb89945c3431c881c Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* | Introduce ForcedUpdate element for componentKatja Marttila2020-12-221-0/+6
| | | | | | | | | | | | | | | | | | | | | | 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>
* | Add option to define operations in component.xmlKatja Marttila2020-12-071-0/+10
| | | | | | | | | | | | | | | | | | | | | | Operations can from now on be declared also in component.xml. The operations are performed, backuped and rollbacked the same way as they would be when defined from scripting api. Task-number: QTIFW-507 Change-Id: Ia509219b94737136c3de25db0cb0c72076b48380 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* | Merge remote-tracking branch 'origin/4.0' into masterKatja Marttila2020-11-241-6/+9
|\| | | | | | | Change-Id: If5205ff6ef2c8989520e24d41595c04d5920d207
| * Doc: Update command line interface referenceArttu Tarkiainen2020-11-041-6/+9
| | | | | | | | | | | | | | Add missing short versions of options and '--confirm-command' reference. Change-Id: I4e4df0a7f883a97b653da1dea4dae878f4e1484c Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Arrange licenses and filter duplicatesJarkko Lehtoranta2020-11-061-1/+2
| | | | | | | | | | | | | | | | | | | | | | - Add a "priority" attribute to the "License" element used in "package.xml" for arranging licenses by priority in the LicenseAgreementPage and in CLI. Priority >0 shows the license on top of others. - Arrange the licenses with the same priority alphabetically - Filter duplicate licenses from the LicenseAgreementPage and from CLI Change-Id: I1dcacdd417d2383b8dc18149e4de329fbf11cfe8 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* | CLI: Add possibility to filter installed packages with regexpArttu Tarkiainen2020-11-041-1/+1
|/ | | | | | Task-number: QTIFW-1953 Change-Id: Ie291e8ae96d46082e342e9bcb152258862813afd Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* CLI: Give more meaningfull return value for installsKatja Marttila2020-09-251-0/+4
| | | | | | | | | | | | | | Instead of returning just true or false when running installer or maintenancetool, utilize the PackagemanagerCore status message. Added also a new status enum, EssentialUpdated, which is returned when calling command 'update' and only essential components are updated. Also fixed a bug when components could be installed even when there were an essential update available. Task-number: QTIFW-1969 Change-Id: I43826301656573b34e1338b49566d199bdcd7468 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Page list widget enhancementsArttu Tarkiainen2020-09-111-0/+4
| | | | | | | | | | | | - Add support for a configurable image shown on top of the page list. - Add missing object names for easier object reference, for example when using stylesheets. - Remove the vertical line separating side widget as this looks particularly ugly on custom styles. Task-number: QTIFW-1939 Change-Id: I16e17e72163068381f54491f7fbe965eb4c5295d Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add command line interface documentationArttu Tarkiainen2020-08-251-0/+181
| | | | | | | Task-number: QTIFW-1724 Change-Id: Ief40dc548e93cd189e3b3ca016652c8641face1e Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io> Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
* Add support for vendor set image decorationArttu Tarkiainen2020-08-251-0/+4
| | | | | | | | | | | | Add possibility to show an arbitrary number of product related, or other images on PerformInstallationPage. These can be specified in the installer configuration file, using <ProductImages> element with one <Image> child element for each file name. Task-number: QTIFW-1900 Change-Id: I2be727d9189963ef1a79046150111dd8c91153c6 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add a page list widget to installer wizardArttu Tarkiainen2020-06-111-1/+9
| | | | | | | | | | | | | | | | | | | | If an installer is configured with <WizardShowPageList> set to true (default), a QListWidget set as a side widget for the wizard will be shown. The list should indicate completed and incomplete pages and the current wizard page. User navigation is not enabled in this change. The page list should honor the visibility of individual pages and update itself dynamically. In addition the visibility of a page in page list widget can be set internally with setShowOnPageList() which overrides other factors when hiding a page. The page item title shown on the list can be set internally with setPageListTitle() for the PackageManagerPage object, or the item can alternatively use the normal page title and the object name. Task-number: QTIFW-1755 Change-Id: I8a792d957a10e2176de5f42f29b1282e8e7667db Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add support for disabling CLI features from configuration fileArttu Tarkiainen2020-05-151-0/+5
| | | | | | Task-number: QTIFW-1760 Change-Id: Ibd0668756700eeab68bce12ddce1866893cc08f9 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Merge remote-tracking branch 'origin/3.2' to masterKatja Marttila2020-03-161-4/+4
|\ | | | | | | Change-Id: Ia4cf718409ce431cce8d766865ecec506426afb9
| * Fix devtool documentationKatja Marttila2020-03-051-4/+4
| | | | | | | | | | Change-Id: I2c1cf408709a0dc3b4a34b21d9f086254b253260 Reviewed-by: Antti Kokko <antti.kokko@qt.io>
* | Fix license check failuresSimo Fält2020-02-281-3/+3
|/ | | | | Change-Id: I123b1c6a06717c37387a636aae8296e27c1df8c0 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Update usage of Apple-related terminologyArttu Tarkiainen2019-08-161-7/+7
| | | | | | | | | | | Replace deprecated Q_OS_OSX macro used in several places with the newer Q_OS_MACOS. Old style reference of Apple's desktop operating system name as "OS X" in documentation and files are also replaced with "macOS" where applicable. Task-number: QTIFW-1406 Change-Id: I0561d5e0d964917ac4fca0702d58a06b85d30e57 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Doc: Don't indicate that you can add pages in a control scriptAndy Shaw2019-06-171-12/+5
| | | | | | | | Change-Id: I6ddfc27334d8f14852cd926653b5ab56851c3fec Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Enable links and text selection in component description fieldsArttu Tarkiainen2019-05-071-1/+4
| | | | | | | | | | | External links can now be included in component description by specifying a proper URL address like this: {external-link}='https://www.qt.io/'. The link fields can be placed anywhere inside package <Description> tags. Task-number: QTIFW-1292 Change-Id: I1d916a58224bdfb6e885445873bf541fad3cf834 Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add tooltip for categoriesKatja Marttila2019-02-041-1/+2
| | | | | Change-Id: I852a236bc2cff0d532a825581e3da4dcdcbbab90 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
* Allow unstable components when categories are usedKatja Marttila2019-01-171-1/+5
| | | | | | | | | | | | | | | Unstable component means that the component has unresolved dependency, script error etc. Installer cannot recover if we are already in component selection view and fetch new packages from a category which has unstable components if AllowUnstableComponent is false. Fixed so that allowing unstable components is forced when categories are used. Ideal solution would be to recover and rollback the install tree if unstable components are found but that requires huge changes to IFW. Task-id: QTIFW-1257 Change-Id: I786df1b8b54c238f50e15b94a06005e244417c97 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>