summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Add possibility to add warning labels from scriptKatja Marttila2025-05-271-0/+29
| | | | | | | | | | | | Introducing new invokable methods, addWizardPageWarning() and removeWizardPageWarning() to add and remove warning messages to existing pages. Warning messages can be added also with existing addWizardPageItem() -function, but the new method utilizes the LabelWithPixmap -class, which draws a warning image and a label with text wrapped. Task-number: QTIFW-3555 Change-Id: Ie7867d369762f7616ce8c7ca47d102111d651da5 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add possibility to add text to LiceseAgreementPageKatja Marttila2025-05-231-0/+4
| | | | | | | | | | New text field is added on top of the LicenseAgreementPage. The text field is empty by default, and developer can add text to it using script interfaces. Task-number: QTIFW-3626 Change-Id: Id08bbb148fe3cdbe08b7b33ced786ba4a734ad1a Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Doc: Update Installer Framework Doc's Installation section imageInkamari Harjula2025-05-201-0/+0
| | | | | | | | | Image updated. Task-number: QTIFW-3818 Change-Id: I1433ea65e1ab0fb54a4d641dd9ae4c6a85b83c72 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* 3rdparty: remove bundled LZMA SDKArttu Tarkiainen2025-05-133-31/+2
| | | | | | | | | | | | | | The bundled library has not been updated in a long time, and has been marked deprecated for use with the IFW for several releases. Remove the obsolete library and all references to it in the repository. Users that have been still using theLZMA SDK archive backend in self-built IFW should migrate to using libarchive, which is now enabled by default. Task-number: QTIFW-3819 Change-Id: I45298de282c2b0b65e8f343d90aa75495e55947a Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add operation for stopping processesArttu Tarkiainen2025-04-301-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Introduce a new StopProcessesForUpdates operation. This operation will be automatically invoked for components requesting processes to be stopped via the component::addStopProcessForUpdateRequest() script method, before installing, updating, or uninstalling the component. The operation has currently only effect on Windows - on Linux and macOS it always returns true. The operation attempts to stop the requested processes via the WM_CLOSE signal, or if a timeout is reached, attempt to terminate it forcefully. The component::addStopProcessForUpdateRequest() retains the old behavior on Linux and macOS, that adds the FakeStopProcessesForUpdates operation for the component, to support blocking the installation action until requested processes are stopped manually by user. Also fix handling of return value for the graceful process shut down in sysinfo_win.cpp. Task-number: QTIFW-3745 Task-number: QLS-1799 Change-Id: I2c6ed887fd9657d9560d6a0f945c654883ab2f0c Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Update documentation screenshotsTeemu Jokitulppo2025-04-2520-0/+0
| | | | | | | | | | | | | | Replaced existing documentation images with updated screenshots reflecting the latest UI Filenames remained unchanged to avoid breaking references Verified that updated images render correctly in the online documentation Task-number: QTIFW-3739 Change-Id: Id3bfaae4f9976c6fbd44860d9465a782b25ae365 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add objectname for component summary areaKatja Marttila2025-04-041-0/+4
| | | | | | | | | To draw borders to the whole area including both titles and treeviews, own objectname is needed for simplifying the stylesheet usage. Task-number: QTIFW-3549 Change-Id: I1a7ea1d474b18ca985c352657fa91cda3fd4e66d Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Allow hybrid MT with offline installerKatja Marttila2025-04-022-13/+48
| | | | | | | | Hybrid Mt with offline installer means that user can use maintenance tool, generated by offline installer, to update the installation. It requires the repositories to be defined in config.xml when creating the offline installer. Hybrid offline installer can be created either with binarycreator with --hybrid option, or with online installer while creating offline installe, also with option --hybrid. When running the offline installer, installer will not use the repositories for installation, the defined repositories are used only when running maintenance tool. Task-number: QTIFW-3726 Change-Id: Ib50fe0094ebe3eced597a80026bec79a58bbb884 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Update 'Ready for Installation' -pageKatja Marttila2025-04-011-5/+17
| | | | | | | | | | | According to new UI specs, 'Ready for Installation' page now contains information about installable and uninstallable packages. Also the title is change to 'Installation Summary'. Task-number: QTIFW-3549 Task-number: QTIFW-3548 Change-Id: I4454a673f3cc3b05c30af8fc019326fe54a09f19 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* DOC: Fix bug in maintenance tool update documentationKatja Marttila2025-03-251-6/+10
| | | | | | | | | | | | | The extraction of maintenance tool to a temporary folder is required only for macOs as Windows already has deferred rename and Linux uses inode. Fixed the bug in documetion where the maintenance tool extract to a temporary folder was performed in all platforms. Also fixed the update.rcc location in macOs. Task-number: QTIFW-3715 Change-Id: I5e7054dd8833be119af856be1f6b896809f5fe15 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Doc: Show IFW versionLeena Miettinen2025-03-191-0/+5
| | | | | | | | - At the top of the sidebar TOC in online docs - In the <title> element of each HTML file Change-Id: Iaec6866851c40b74d5d604b99290eb45baeca492 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add ability to ask some command line detailsKatja Marttila2024-12-021-1/+25
| | | | | | | | | Added possibity to ask from script if --nd (--no-default-installations), --nf (--no-force-installations), or --sv (--show-virtual-components) options are set when running installer from CLI. Change-Id: I6a90573cc05360d4a51673cea0d23cd5ef3f80cc Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* PackageManagerGui: add signal to indicate page transition is completedArttu Tarkiainen2024-11-251-0/+7
| | | | | | | | | | | Introduce PackageMangerGui::currentPageChanged(int oldId, int newId) signal, which is emitted when a page transition is completed. This is useful in cases where we need to know the new and previous page ID's to perform some post-operation for a specific page transition. Task-number: QTIFW-3606 Change-Id: I3f47ba22ebd1d380d3f545f386f67b8da1c24446 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Create own class for component space informationKatja Marttila2024-11-181-0/+6
| | | | | | | | We need to show space information in several pages, so moving the implementation to own class for easy pick to other places. Task-number: QTIFW-3582 Change-Id: I597cb27dbb1ccf87079c1afeab7e8206be5f461f Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Doc: Add All topics into ifw.qdocconfInkamari Harjula2024-10-181-0/+1
| | | | | | | All topics added into ifw.qdocconf file. Change-Id: If4a8efedc171f04cc4db83b05991b7d00422c74b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Introduce a new signal when gui elements are readyKatja Marttila2024-10-181-0/+6
| | | | | | | | | For customizing installer gui elements in extensions, we need to know when the elements are ready and can be customized. Task-number: QTIFW-3480 Change-Id: Ieeb938cd3a6c6819861e66e2bcd1d898bc5f8984 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Doc: Create a two-level sidebar TOCInkamari Harjula2024-10-042-5/+75
| | | | | | | | | Two-level TOC created. Task-number: QTIFW-3517 Change-Id: Icf0b8db09d8746838033d87a465fd2aed5193ae7 Reviewed-by: Katja Marttila <katja.marttila@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Use the new tools front page templateInkamari Harjula2024-10-0213-21/+131
| | | | | | | | IFW front page content put into new template. Typo fixed from image. Task-number: QTIFW-3514 Change-Id: I47db1ef63f73fcb1b6bc55a9c88212a47e00e3db Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Doc: Create an Installation topic needed for the new front pageLeena Miettinen2024-09-304-18/+59
| | | | | | | Task-number: QTIFW-3514 Change-Id: I27524b263035e75accf29f67df1f9840b7b1c422 Reviewed-by: Katja Marttila <katja.marttila@qt.io> Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
* Fix macos app bundle updateKatja Marttila2024-06-061-1/+17
| | | | | | | | | | | | | | MacOs app bundle cannot be replaced while it is running, if the app is used after replace, e.g. operations are called from another component to be installed. Fixed so that maintenance tool app bundle can be extracted to a folder in install script, and function deferredRename, which is called as last step when running installer, will move the app to root and removes the possible subfolder which was created during extract operation. Task-number: QTIFW-3408 Change-Id: I62d873abd3155be533fca2f80afcb820042536d2 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* DOC: Improve maintenance tool signing instructionsKatja Marttila2024-06-051-1/+4
| | | | | Change-Id: Id1e16583a818f8c72b3713d91c50471cb63d50e1 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Allow overwriting undo in some operationsKatja Marttila2024-04-051-0/+23
| | | | | | | | | | | | | | Added possibility to overwrite undo in copy, move, delete, mkdir, rmdir, appendfile and prependfile operations. Undo is performed when component is uninstalled or updated, by adding UNDOOPERATION to the end of argument list will skip the undo operation. Also added unit tests for rmdir and prependfile operations Task-number: QTIFW-3333 Task-number: QTIFW-393 Change-Id: I88dbb16d2ebabe42b4ff810e6196da0be8b4cc65 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Fix QDesktopServices propertiesKatja Marttila2024-04-021-2/+6
| | | | | | | | | | QStandardPaths has changed in Qt 6.6, changing the script properties for script usage accordingly. Task-number: QTIFW-3334 Change-Id: Ib0bf1f0370d8f8691436df0df28a445e39bdb39f Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io> Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
* Fix productType function return value in macosKatja Marttila2024-03-281-1/+1
| | | | | | | | In Qt6, productType is macos, whereas in Qt5 it was osx. Task-number: QTIFW-3309 Change-Id: I403c8a2734eac7a511f742bdd1be130090f7af07 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Fix QFileDialog documentationKatja Marttila2024-03-221-2/+7
| | | | | | Task-number: QTIFW-3320 Change-Id: I3cd4e19f4bfb192ef929b2f724ee77c0b770f06d Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add possibility to change button textKatja Marttila2024-02-221-1/+23
| | | | | | | | | | Sometimes the button texts in installer are not something that is suitable. Added possibility to change button texts from script to a specific installer page. Task-number: QTIFW-711 Change-Id: I2883cda6d770843c3617fda4e6b07d102a357730 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Merge remote-tracking branch 'origin/4.7' into masterKatja Marttila2024-01-223-20/+25
|\ | | | | | | Change-Id: Id9fe7a127a72b58732f5dffd11c4c9c7c1c56060
| * Doc: Update getting started documentationKatja Marttila2024-01-181-17/+14
| | | | | | | | | | | | Change-Id: Ia2e5a7c2039270e7b33d5f7b449a3c9c3b38cd59 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
| * Doc: Fix wrong link in documentationKatja Marttila2024-01-181-1/+1
| | | | | | | | | | | | | | Task-number: QTIFW-3248 Change-Id: I093097d899bb7784965ce34af9fa6de396186d78 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io> Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
| * Doc: Link to external dependenciesInkamari Harjula2024-01-121-2/+5
| | | | | | | | | | | | | | | | In Supported Platforms section, link to Linux dependecies added. Task-number: QTIFW-3170 Change-Id: I0d22791113b3d1d6ff0bebb421d6f56143199b0b Reviewed-by: Katja Marttila <katja.marttila@qt.io>
| * Allow disabling usage of configured repositories for offline installersArttu Tarkiainen2023-12-291-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, offline installers did not consider configured repositories for metadata fetch, but this was changed in a fix for bug report QTIFW-3078. Some users were relying on the previous behavior, so make it configurable in the installer's config file, and default to the new behavior. Task-number: QTIFW-3160 Change-Id: I26c0ab825f080f81ce2320e0be5f75334207c33e Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Doc: Update texts and images on IFW landing page and overview pageInkamari Harjula2024-01-153-25/+62
| | | | | | | | | | | | | | | | | | Texts modified on landing and overview pages. New screenshots to be added later. Image in Choosing Installer Type section was updated. Task-number: QTBUG-117600 Change-Id: I0fa76d25519d2488d6ff68a93bd6b7761f592b3c Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Doc: Fix documentation build configurationTopi Reinio2023-12-084-138/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The custom qmake documentation build target did not correctly locate private include paths for Qt modules. Fix this by replacing dashes with underscores (e.g. qtcore-private -> qtcore_private) before querying the paths. Remove duplicate entry for qtcore-private (it's already added at top level). In ifw.qdocconf, fix relative additional include paths. Remove all non-existent paths from the configuration. Use the correct URL for the online documentation. Remove the now-obsolete custom module header, and let QDoc build an artificial one based on 'headerdirs'. In passing, fix minor issues in the documentation sources. Change-Id: I5cdbd64307448014fa8b73a70378627fdb89b942 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | DOC: Remove unused signalKatja Marttila2023-12-071-18/+0
| | | | | | | | | | | | | | | | | | rootComponentsAdded -signal is not used anywhere, in case the components are added connect to componentAdded -signal instead Task-number: QTIFW-807 Change-Id: I148e74bd9f1650ae09f0020269fb7ed2349b5d3b Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* | Improve Settings -operation documentationKatja Marttila2023-12-071-0/+1
|/ | | | | | | Task-number: QTIFW-893 Change-Id: I7b995d021963329c438198c3f4fb02832b014090 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add buildCpuArchitecture() to systemInfoKatja Marttila2023-11-221-1/+20
| | | | | | | | To access buildCpuArchitecture from script Task-number: QTIFW-3224 Change-Id: I02086f7d3e064fe53d6fa9322b8832110c40c6b1 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Update INSTALL fileKatja Marttila2023-11-151-1/+1
| | | | | | | | IFW builds only with visual studio compilers in Windows, updating the INSTALL file accordingly Change-Id: Ia93c3af8e4798e5cd862acd56a3750a0d7b39ed7 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Unify maintenance tool nameKatja Marttila2023-10-137-60/+61
| | | | | | | | | | Maintenance tool was written with both capital letters and non-capital letters, unifying the naming and writing with non-capital letters. Also wrote the name behind a macro, in case we some day want to change it. Task-number: QTIFW-3169 Change-Id: Ic4da06a14edd1d9675704befb5599d2c54747446 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* CLI: adjust 'search' command behavior with --type optionArttu Tarkiainen2023-10-051-5/+17
| | | | | | | | | | | | | | In case the "--type=aliases|packages" option is omitted, search first for aliases, and if not found, search for components. If the option is specified, search only given type. This changes the behavior from previous one, where only aliases were considered for the search by default, if the type option was omitted. Change-Id: Ie01ea85e1b88376f8df3edbf864d1e78788c3464 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Fix tiny documentation flawKatja Marttila2023-10-021-1/+1
| | | | | | Task-number: QTIFW-1217 Change-Id: I94de47861a4751a7807ae5482b2feaad5faa60fb Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Update terminology for dependency properties for aliasesArttu Tarkiainen2023-09-292-9/+9
| | | | | | | | | Change "Requires" to "Required" and use plural form for the dependency properties, to be more uniform with the dependency properties for components. Change-Id: Iccb36701bc32ebafd27914272225ad1615c5f9fa Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Add support for optional alias dependenciesArttu Tarkiainen2023-09-292-2/+15
| | | | | | | | | | | | In addition to RequiresComponent and RequiresAlias, introduce new OptionalComponent and OptionalAlias properties for component aliases. The new properties are used to declare optional requirements for aliases, which do not cause the declaring alias to become unstable in case the referred component or alias is missing from the installer. Task-number: QTIFW-3166 Change-Id: I43c8cd08099e879180ec7e028b55836750c727bd Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Fix documentation warningsKatja Marttila2023-09-251-0/+2
| | | | | Change-Id: I68ee86163c3b4d825633efce6dba9f1c0d23ed39 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add support for component aliasesArttu Tarkiainen2023-09-146-7/+131
| | | | | | | | | | | | | | | | | | Introduce concept of component aliases, which act as an alternative way for referring a set of related components. Component aliases are declared in an alias definition file, which is included to the created installer's binary layout as a resource. The file lists the available aliases, including metadata - such as name, version, and description - and the list of components and other aliases the alias requires. Aliases can be referred only from the CLI for the time being, with the supported commands 'install' and 'search'. Task-number: QTIFW-2978 Change-Id: I281f171cc7d932ce496051d7090ae169a4709eec Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Reintroduce custom documentation build targetsTopi Reinio2023-08-173-12/+129
| | | | | | | | | | | Documentation build targets have been removed from Qt 6 when building with qmake. Reintroduce custom targets to call qdoc, qhelpgenerator, and qtattributionsscanner via 'html_docs' and 'docs' targets. These are adapted from similar targets once used by Qt Creator. Change-Id: If572b709c56860a9949c1f4a5ae66a660e2a621e Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add documentation about separators in operationsKatja Marttila2023-06-091-0/+4
| | | | | | | | | | Some operations in Windows might need native separatos. Adding documentation how the separators can be easily converted to native style. Task-number: QTIFW-2578 Change-Id: I20c44fdaef98095add32421a6303570c6372a056 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Fix admin rights handling during installer/updater/uninstaller runsArttu Tarkiainen2023-05-221-1/+13
| | | | | | | | | | | | | | | | | | The installer.gainAdminRights() and installer.dropAdminRights() methods are invokable from the scripting API. During installing, updating or uninstalling components, installer does it's own decision making to request and drop admin rights on-demand, but this could be overridden with the aforementioned methods. This was not taken into account, instead it was only checked if admin rights were gained in the context of the calling method. Fix by checking if the admin rights were present at the start of the installer, or if they were requested by anyone during installation. Task-number: QTIFW-2929 Change-Id: Ie4f6fc0ac746183b00f460a2e60c57c2eae9808c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Fix documentation about network shareKatja Marttila2023-05-091-1/+2
| | | | | | | | | | Creating a shortcut to network share in installer is not possible in Windows. Task-number: QTIFW-2933 Change-Id: Ic6594e7baedf581dece6692882443afe47b2040e Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Unify handling of processes to close for 'updating' componentsArttu Tarkiainen2023-04-211-0/+8
| | | | | | | | | | | | | | | | | | | There was behavioral mismatch of handling processes to stop for updates between GUI and CLI modes. For CLI, each command that would make changes to components would recursively check the installation directory for running processes early on, and block continuing if such processes were found. In addition to this, the component scripts may have requested to stop processes before performing component 'updates' (add/remove/update). For GUI, only the latter functionality was utilized, so remove the early checks from the CLI side to make the behavior uniform. Task-number: QTIFW-2927 Task-number: QTIFW-3009 Change-Id: I028e699c43ef4352593b49ccc8a927644916c41a Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* Allow shortcuts for https links in WindowsKatja Marttila2023-03-291-1/+1
| | | | | | | Task-number: QTIFW-964 Change-Id: If666d7d651f8240e3e7d4c25d9e9d7d81cbe1b39 Reviewed-by: Katarina Behrens <katarina.behrens@qt.io> Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-17 02:47:32 +0000