summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Docs: Fix doc on gui::showFinishedPage()Martin Kampas2020-11-041-1/+1
| | | | | | | Task-number: QTIFW-798 Change-Id: I9ed5bb585cc0b09cd0a17c535e7073d6e7bf4fc8 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* 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>
* 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>
* Replace hand-rolled doc targets with ones provided by QtTopi Reinio2020-09-166-144/+140
| | | | | | | | | | | | This helps to provide correct include paths to QDoc as it requires them from 5.11 onwards. Add a custom module header that pulls in the required header files into the doc build. Change-Id: I857ec5cd49e6c6c586baed6f1e39f2e9ceb900b4 Reviewed-by: Katja Marttila <katja.marttila@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Fix documentation warningsTopi Reinio2020-09-161-35/+34
| | | | | | | | | These changes fix many of the documentation warnings when building with a recent version of (Clang-integrated) QDoc. Change-Id: I5714635a25707cd7ab7bec209fa043a95f0b9832 Reviewed-by: Katja Marttila <katja.marttila@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@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-253-4/+300
| | | | | | | 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>
* Documentation fixesKatja Marttila2020-07-032-2/+31
| | | | | | | | Added missing documentation and fixed warnings. KDUpdate documentation not added in this commit. Change-Id: Idc0b167bed95b7ae4a46a350290fdb241aa94448 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add possibility to add custom widget from script to certain positionKatja Marttila2020-06-251-4/+9
| | | | | | | | | | | If several custom widgets are added to same page, the order of the widgets is arbitrary. Added a new member to addWizardPageItem which can define the position of the widget in the page, relative to another custom widgets. Non-custom widgets are always placed on top as before. Task-number: QTIFW-1847 Change-Id: Iadafef3a08e60a8b05b959cb06caea2a2042b419 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add function to get information if default install is performedKatja Marttila2020-06-251-0/+6
| | | | | | Task-number: QTIFW-1847 Change-Id: I737b9b527c25e089386f74038b57a83f3d7e2062 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Add possibility to select/deselect component from script using coreKatja Marttila2020-06-251-0/+12
| | | | | | | | | We might not have componentselection page visible, so we need a possibility to select/deselect components also using core. Task-number: QTIFW-1847 Change-Id: I85ccf0602144f843c15ef7c0818ba435d36bdac5 Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@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 function to enable button click with objectnameKatja Marttila2020-06-041-0/+7
| | | | | | Task-number: QTIFW-1707 Change-Id: I8574ef96df6a00e577549342d4a4336207dcd9ec Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* CLI: Add new option --file-query to auto answer QFileDialogKatja Marttila2020-05-262-2/+24
| | | | | | | | | | | | | QFileDialog.getExistingDirectory and QFileDialog.getOpenFileName can be called from scipt. If command line interface is used, user must type the correct directory or file name from command line during install. With --file-query option user can give the values when running the installer or maintenancetool with syntax --file-query filedialogId=C:/temp,filedialogId2=C:/temp/file.txt. Task-number: QTIFW-1631 Change-Id: I5e58be6b509cf00de832646ef31ec4eda90773be Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Doc: Add scripting api documentation for setAutoAcceptLicenses()Arttu Tarkiainen2020-05-151-0/+8
| | | | | | Change-Id: I5478b6bf6d62f6d6db78e3d3ae3dfaeee573c220 Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io> 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>
* CLI: Add option to read arbitrary user inputKatja Marttila2020-05-151-0/+14
| | | | | | | | | | | Added new readConsoleLine() function which can be used to read user input from console. Function can be only called when command line instance is used without gui. Task-number: QTIFW-1631 Change-Id: Ic856f4bafc4a8d469d3fe497b4e0321e104df499 Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io> Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
* Doc: Update supported Qt versionArttu Tarkiainen2020-04-201-1/+1
| | | | | | | | | Related change 9501f454d3dae429edd20f746a3e4b3aac76f6c9. Change-Id: Ie07e8fb790045712b99ac19abab68949e35a17ae Reviewed-by: Katja Marttila <katja.marttila@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
* Add unit tests for CreateDesktopEntryOperationArttu Tarkiainen2020-03-261-1/+2
| | | | | | | | | Also add note of the intended target platform to documentation. Task-number: QTIFW-1696 Change-Id: I60f6cfcaf03a32c2dd466c529b81dde477f8e3bd Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Refactor and add unit tests for metadatajobKatja Marttila2020-03-241-2/+10
| | | | | | | | Split long functions into smaller understandable functions, added unit tests for metadatajob. Change-Id: Ib423eab3c9ae7771fb032b99f767f96e52266ea7 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
* Merge remote-tracking branch 'origin/3.2' to masterKatja Marttila2020-03-162-6/+6
|\ | | | | | | Change-Id: Ia4cf718409ce431cce8d766865ecec506426afb9
| * Fix devtool documentationKatja Marttila2020-03-052-6/+6
| | | | | | | | | | Change-Id: I2c1cf408709a0dc3b4a34b21d9f086254b253260 Reviewed-by: Antti Kokko <antti.kokko@qt.io>
* | Add command line option to start the installer binary as uninstallerArttu Tarkiainen2020-03-021-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Add option "--uninstaller" to start the installer binary explicitly as uninstaller. This complements options "--updater" and "--manage-packages". Add convenience functions for setting and checking if the magic binary marker has been set by the user. Task-number: QTIFW-1639 Change-Id: Ie40ba9c56e09be079e309bca985b19a8a7bef7ef Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Fix license check failuresSimo Fält2020-02-2823-69/+69
| | | | | | | | | | Change-Id: I123b1c6a06717c37387a636aae8296e27c1df8c0 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Merge remote-tracking branch 'origin/3.2' into masterKatja Marttila2020-01-164-6/+30
|\| | | | | | | Change-Id: Ie42b694119ecaa59c9df4aa0253663107ef0c68c
| * Minor documentation fixesKatja Marttila2020-01-071-4/+4
| | | | | | | | | | Change-Id: I4a8c1ca489ed7d7779c5235101fb57be8bd88274 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Update build instructions to documentationKatja Marttila2020-01-071-5/+6
| | | | | | | | | | Change-Id: I111829be3183a1e195af4f79c914e6309f9ada9f Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
| * Documentation fixesKatja Marttila2019-12-173-1/+24
| | | | | | | | | | Change-Id: Ibffb5470d374c8d612791f48c951deddd00f3121 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Merge remote-tracking branch 'origin/3.1' into masterKatja Marttila2019-11-201-2/+4
|\| | | | | | | Change-Id: Icc077e3757b84b2367b2a7dd9c1e389f6845365b
| * Fix env variable remove on WindowsJohanna Äijälä2019-10-111-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Removing env variable failed on uninstallation on Windows if the env variable value had @TargetDir@ in path. File separators got changed from Windows style to unix style. Update documentation to inform users to use '\\' as separators when setting a path as environment variable. Tested with following values (component.addElevatedOperation(...) in components.qs): "@TargetDir@\\lib\\system\\qtplugins" "not_a_path_but_variable_with_slash_\\qtplugins" "not_a_path_but_variable_with_slash_/qtplugins" "%SystemRoot%\\lib\\system\\qtplugins" "12345" Task-number: QTIFW-1148 Change-Id: Iaa48d890e70afdbe56bbf389dd4994d5ae91b316 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
| * Fix CreateLink operation destination string formatting on WindowsArttu Tarkiainen2019-10-101-2/+2
| | | | | | | | | | | | | | | | | | | | | | - Fix string formatting syntax in createJunction() method. - Calculate destination directory string length in bytes rather than characters count. - Make minor alterations to operation usage documentation. Task-number: QTIFW-1443 Change-Id: Ia7f6525c865a3e8a6da5376059111c1ef87353ac Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Merge remote-tracking branch 'origin/3.1' into masterKatja Marttila2019-08-2312-48/+111
|\| | | | | | | Change-Id: I8b203e12283374aed707e0e89c2f73d44ff296cb
| * Update usage of Apple-related terminologyArttu Tarkiainen2019-08-1610-23/+23
| | | | | | | | | | | | | | | | | | | | | | 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: Define CreateShortcut operation as a Windows-specific featureArttu Tarkiainen2019-08-151-2/+2
| | | | | | | | | | | | | | Task-number: QTIFW-1399 Change-Id: I81d5bf2c2abde9f0e49f5ea8cb99845e14159800 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
| * Doc: Fix wrong values in Settings Operation summaryArttu Tarkiainen2019-08-151-4/+4
| | | | | | | | | | | | Task-number: QTIFW-1386 Change-Id: Ic8faf41fd972505353f6c2e461ddfb47a8db6d94 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Doc: Update getting-started pageKatja Marttila2019-08-131-5/+22
| | | | | | | | | | | | | | Task-number: QTIFW-1185 Change-Id: I602425589b3b2e0482d025a02b06f4b4c27ac330 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
| * Doc: Don't indicate that you can add pages in a control scriptAndy Shaw2019-06-172-14/+7
| | | | | | | | | | | | | | | | Change-Id: I6ddfc27334d8f14852cd926653b5ab56851c3fec Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
| * Update documentation for Component Selection PageArttu Tarkiainen2019-06-031-0/+53
| | | | | | | | | | | | | | | | | | | | | | | | Repository categories introduced in IFW 3.1 can cause behavior changes in older automation scripts that use component selection methods. Update documentation to include new items on Component Selection Page and provide an example code for fetching components from a category. Task-number: QTIFW-1354 Change-Id: Icf93d1325563d3bdf6a38799ab260b13f4078a81 Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io> Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Add regular expression support to replace operationArttu Tarkiainen2019-08-161-2/+10
| | | | | | | | | | | | | | | | | | | | Introduce search with regular expressions support to replace operation. Add unit tests and make associated documentation changes. Task-number: QTIFW-889 Change-Id: I82e30056030ebc900be49046fda1903b27a2824d Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Change ApplicationsDir variable on macOS to return "/Applications"Arttu Tarkiainen2019-08-161-0/+6
|/ | | | | | | | | | | | | | | QStandardPaths::standardLocations(QStandardPaths::ApplicationsLocation) first element returns $HOME/Applications, as being user writable it has a higher priority. Change the variable to return system wide /Applications as it is a more expected default. Add the user-specific applications directory as its own variable, and make associated documentation changes. Task-number: QTIFW-1011 Change-Id: Ia81a1f5dafdea8665d5f9fc1df3799e59858e5aa 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>
* fix missing backslashed with double backslash commandFrederik Schwarzer2019-04-021-2/+2
| | | | | | Change-Id: I0404f3d08d2a4bdc3f5d3ccafe8a016486d4ecdb Fixes: QTIFW-1037 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Write desktop entry and items to the correct foldersRainer Keller2019-02-041-5/+4
| | | | | | | | | | | | Data should not be written to directories in XDG_DATA_DIRS. The spec state that files should only be writen to the directory in XDG_DATA_HOME. Change-Id: I755963fa2f70d03c77d7beec0e3f87accde925d0 Fixes: QTIFW-1269 Reviewed-by: Nikos Chantziaras <realnc@gmail.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@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>
* Add possibility to preselect categories in config.xmlKatja Marttila2019-01-171-2/+4
| | | | | Change-Id: I280247cb5155622ade604074c5a71a276b0fb629 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>