aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Doc: Fix a broken link to the qbs moduleLeena Miettinen2018-02-011-1/+1
| | | | | | | | The commit to remove this file is in master, so this link needs to be fixed in 1.11. Change-Id: Ieb2dc1a6800f271783cd8f39e48dfbe7eb3bcc65 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Merge 1.10 into 1.11Christian Kandeler2018-01-262-1/+56
|\ | | | | | | Change-Id: Ib49f863008a9c4a3b8956686de019e2f133c244f
| * Do not use Qt's documentation macrosEike Ziller2018-01-252-1/+54
| | | | | | | | | | | | | | | | | | | | | | Qt 5.10.1 makes changes that would require changes in the Qbs documentation build. Since it doesn't make sense that changes in Qt documentation configuration files affect Qbs documentation, stop using Qt's macros file. Change-Id: I12bad221dec7204eb2bbabced2cda2af9941315e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Fix docs regarding help2man - it's not a "Perl module"Jake Petroules2018-01-081-1/+1
| | | | | | | | | | | | | | Amends 8027000 Change-Id: I7f79e93c9160bef626aa49f4af4d507efc12cb77 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Account for the Qbs docs build now requiring additional dependenciesJake Petroules2018-01-052-2/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Document it, and install the dependencies in the Docker images. For the man page build, the installed version of the qbs app is now used to get the help text rather than the non-installed version, since the non-installed version may not be able to find all library dependencies (like Qt) on some platforms by default. The build also now depends on the other executables as well since their presence affects the output of qbs --help. Change-Id: Ic9896231aa76a346180bf30f7b2483391f5e4ea0 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Improve the documentation for cpp.separateDebugInformationJake Petroules2018-01-031-1/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | This adds information about what types of files this property causes Qbs to generate, in order to help user discovery of the property, for example by searching for "pdb" or "dSYM". This change also corrects the default value listed for cpp.separateDebugInformation, by mentioning that it also defaults to true on Apple platforms. Change-Id: Ida51a55a236e823b56cc05e2d8d528614d2a5dda Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Describe constructing the path to the installation target dirLeena Miettinen2018-01-032-2/+47
| | | | | | | | | | | | | | | | Add an example that specifies values for the properties. Task-number: QBS-1237 Change-Id: I645a1b0bca099411035fae98acdbf27e7a942d3d Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Add links to CLI command optionsLeena Miettinen2018-01-035-7/+13
| | | | | | | | | | | | | | | | | | Added targets to the file where the options are documented, to avoid having to use the weird URLs automatically generated by QDoc. Change-Id: I3bffa79b564ffb9582f814124881dcd0cc60aa7d Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Add some more links to Item docsLeena Miettinen2017-12-228-20/+27
| | | | | | | | | | | | | | Mostly replacing the \c command with the \l command. Change-Id: Ifbda6488cff7a249c554c5213054b627bfc687d5 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Delete obsolete information about StaticLibrary itemLeena Miettinen2017-12-221-10/+0
| | | | | | | | | | | | | | | | There are no additional dependencies or properties for Android targets. Change-Id: I4e790976b54c02c54ba5b6fde070b80340687306 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Use the \QBS macro for the product nameLeena Miettinen2017-12-221-3/+3
| | | | | | | | | | Change-Id: I5cf6c06035af309fc8460ae0246af10308eea57b Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Add some links to commands and propertiesLeena Miettinen2017-12-224-84/+82
| | | | | | | | | | | | | | Usually, replace the \c command with the \l command. Change-Id: I062e9a3f34874e832c972773b88d58225e1621b0 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Move external link URL to the external-resources fileLeena Miettinen2017-12-222-1/+6
| | | | | | | | | | Change-Id: I924e1354e870df990accb5f4778b4d34797535c1 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Doc: Use the "var" property type for "array of objects" and "object"Leena Miettinen2017-12-213-3/+3
| | | | | | | | | | Change-Id: Iac76523129d1cd35e16886b2c3663126e0670dcc Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Add missing space to InstallPackage item docsLeena Miettinen2017-12-211-1/+1
| | | | | | | | | | Change-Id: I59ca9d453c864f428f9518e03aa3b8cd10b42286 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Use Qt module name without prefix as link text in tableLeena Miettinen2017-12-211-7/+7
| | | | | | | | | | | | | | For consistency. Change-Id: I63eec9ad202ee74fde009cdb06060f841057fa93 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Use QML commands to document modulesLeena Miettinen2017-12-2155-4082/+5660
| | | | | | | | | | | | Task-number: QBS-1245 Change-Id: I996bb44a1db9aae71ef42bca87265371de951272 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Remove bogus content from Product item documentationChristian Kandeler2017-12-201-2/+0
| | | | | | | | | | | | | | Probably some left-over artifact from the rewrite. Change-Id: Ibf93f84073e9b9a3270e004bed28fbdd6f113166 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Merge 1.10 into masterChristian Kandeler2017-12-152-1/+6
|\| | | | | | | Change-Id: Iab942ed25d06038cf8c172eb70dcd8e9a720e1c8
| * Fix visual glitch in CppApplication documentationChristian Kandeler2017-12-131-1/+2
| | | | | | | | | | Change-Id: Id9ec3f24a80a684b73aadaabd785488490c1feab Reviewed-by: Jake Petroules <jake.petroules@qt.io>
| * Doc: Update the sidebar in online docs to show the current TOCLeena Miettinen2017-12-071-0/+4
| | | | | | | | | | Change-Id: Ia328393ef2914cac0a3952bce69049b18ea9fdfa Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
| * Bump version numberChristian Kandeler2017-12-071-3/+3
| | | | | | | | | | | | | | 1.10.0 -> 1.10.1 Change-Id: I302620919fffb7cb0021711adcd9446ebf2b9d8f Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Introduce cpp.rpathOriginJake Petroules2017-12-081-0/+8
| | | | | | | | | | | | | | | | [ChangeLog] Added property cpp.rpathOrigin which evaluates to @loader_path on Darwin and $ORIGIN on other Unix-like platforms. Change-Id: If5770a83ae32f29ee520fd00b07ed8f0caf6bd48 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Add the qbs.toolchainType propertyJake Petroules2017-12-072-7/+25
| | | | | | | | | | | | | | | | | | [ChangeLog] Added the qbs.toolchainType property, which is a scalar version of the qbs.toolchain property and is used to set the current toolchain. Change-Id: I65b2ac44c0be0ea79fd0b1699f8f77c93def3437 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Merge "Merge 1.10 into master"Christian Kandeler2017-12-043-0/+18
|\ \
| * | Merge 1.10 into masterChristian Kandeler2017-12-013-0/+18
| |\| | | | | | | | | | Change-Id: Id05a2501c276577788e67b015fc2d80473640a4d
| | * Installer modules: add a "helper" file tag to pull in dependent inputsJake Petroules2017-11-303-0/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Use case: building an Inno Setup, NSIS, or WiX project often depends on artifacts created by other products (executables, shared libraries, etc.). This allows the rules which create these installer files to depend on relevant installable artifacts. [ChangeLog] The Inno Setup, NSIS, and WiX modules' rules now have a dependency on installable artifacts of dependencies by default, via the default item templates InnoSetup, NSISSetup, and WindowsInstallerPackage. This can be explicitly controlled via the dependsOnInstallables boolean property of those item templates. Change-Id: Ia12f7d9965091c06ab83ba86836ec989c899f765 Reviewed-by: Thorbjørn Lindeijer <bjorn@lindeijer.nl> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | | Fix a flipped true/false in Product.consoleApplication docsJake Petroules2017-12-011-2/+2
|/ / | | | | | | | | | | Change-Id: Ib193029b5ec8b375e6fafb0f4ea3c67411519960 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Use QML commands to document Qbs convenience itemsLeena Miettinen2017-11-3024-360/+348
| | | | | | | | | | | | Task-number: QBS-1245 Change-Id: I158e4c91b9306e74919901935f7d8eb546623d41 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Use QDoc QML commands to document Qbs language itemsLeena Miettinen2017-11-3030-998/+1189
| | | | | | | | | | | | Task-number: QBS-1245 Change-Id: I470a629312b1c65ea9e51c603607c486115a304c Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Add script to strip bogus QML import statements from the docsChristian Kandeler2017-11-292-2/+198
| | | | | | | | | | | | | | | | | | | | | | ... and make use of it in the qbs build. Otherwise, we'd ship broken HTML files in our release packages. The script is a stripped-down version of clean-online-docs.py from the doctools repository. We also adapted it to keep the inheritance information. Change-Id: I9c6d0dcc5c11a1bc24bed3eec3ebe04908bae4f3 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Add qbs.targetPlatform and qbs.hostPlatform propertiesJake Petroules2017-11-222-26/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This allows users to set the target platform from within project files, since it is a scalar value. The values of qbs.targetOS and qbs.hostOS are now derived from these new scalar properties. [ChangeLog] Added qbs.targetPlatform and qbs.hostPlatform properties which are scalar versions of qbs.targetOS and qbs.hostOS. qbs.targetPlatform is a "write-only" property that can be used to set the OS/platform that is being targeted, while qbs.targetOS and qbs.hostOS should continue to be used to *read* the OS/platform that is being targeted. qbs.targetOS is also now read-only. Task-number: QBS-1070 Change-Id: Id3fd206a5b2ebee2d626f3e5ab02ecd1dc90d90a Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Consider library dependencies when setting up run environmentChristian Kandeler2017-11-221-0/+11
| | | | | | | | | | | | | | | | | | | | There is no need to hardcode a heuristic in qbs.commonRunEnvironment when we can find out the actual paths. Task-number: QTCREATORBUG-19274 Change-Id: I7a07eb9ff658e38a15c954972370242651114b11 Reviewed-by: Jake Petroules <jake.petroules@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
* | Give the setupRunEnvironment script an additional parameterChristian Kandeler2017-11-223-1/+15
| | | | | | | | | | | | | | | | | | | | | | Required by follow-up commit. [ChangeLog] The Module.setupRunEnvironment script now has a new parameter "config". Users can set it via the --setup-run-env-config option of the run command. Change-Id: I1be57fcff5321874cf3dcf4fb3a7ef7d6f69a8a5 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Make Module.setup{Build,Run}Environment first-class citizensChristian Kandeler2017-11-201-5/+11
| | | | | | | | | | | | | | | | | | | | | | They did not have the project and product variables available, and they accessed module properties in a way that made it look as if they were normal properties rather than scripts, which was misleading. Now everything works the same as in Rule scripts and JS commands. Task-number: QBS-744 Change-Id: I11d70876185d528282a56747747dd8310a77fbc4 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Add support for creating .ico and .cur files using icotool (icoutils)Jake Petroules2017-11-152-0/+136
| | | | | | | | | | | | | | | | | | | | | | | | ImageMagick has support for these formats but is not suitable because it does not have the ability to set cursor hotspots. This patch is preparation towards QBS-73. [ChangeLog] Introduced the ico module for creating .ico and .cur files Change-Id: I9a917b3ee5983bc59fba1a5740540299d8d9708f Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Describe the build process at a general levelLeena Miettinen2017-11-142-9/+101
| | | | | | | | | | | | | | Add an image. Change-Id: Ia08903501c9ef6d210121ef69ea448308920d849 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Allow disabling pieces of the Qbs project by categoryJake Petroules2017-11-091-44/+48
| | | | | | | | | | | | | | | | This allows the "resources build" to not rely on a valid Qt profile. Task-number: QBS-1238 Change-Id: I1c743a95993099250da714c794b6e0ac16133609 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Enable modules to declare target artifactsChristian Kandeler2017-11-071-1/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | Such artifacts appear to rules just like target artifacts of products. This functionality will be useful for auto-generating qbs modules from products. [ChangeLog] Modules can now declare target artifacts using the new filesAreTargets property of the Group item. Task-number: QBS-882 Change-Id: I3bba000be9a1057d9fef01e5576363719ff1f244 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* | CLI: Fix the --version optionChristian Kandeler2017-11-072-0/+53
| | | | | | | | | | | | | | | | | | | | This option was supported in a very hacky way by attaching it to the "build" command, where it does not belong. Add a dedicated command instead and support the option variant in the same way as we do for --help. Change-Id: Ib8f1a0e44f9ae669093f059c86518138df510bc3 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* | Add BinaryFile service to manipulate binary filesDenis Shienkov2017-11-071-0/+114
| | | | | | | | | | | | | | | | | | [ChangeLog] Added the BinaryFile service for reading and writing binary data files. Change-Id: I93378c448a367472c4dd9ad5e715f70d88d7f58e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Remove qbs-qmltypes appJake Petroules2017-11-021-3/+0
| | | | | | | | | | | | | | | | Now that we generate the qbs.qmltypes file during the build, it is no longer needed. Change-Id: I3180f55074b291d645abad65437d0cba4c80df25 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | cpp module: Add property for linking-only driver flagsChristian Kandeler2017-11-021-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | For instance, GCC has various flags that are only used for linking, but that are not ld flags and thus must not be escaped via "-Wl,". [ChangeLog] Added cpp.driverLinkerFlags for flags to be passed to the compiler driver only when linking. Task-number: QBS-1236 Change-Id: Idc1498a74e0219306fda99de9adad2730f3a6f73 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Docs: Add a how-to for accessing the repository stateChristian Kandeler2017-11-011-0/+25
| | | | | | | | | | Change-Id: I8d5c6792fcd63b47260bfe0e28f06cfb8be57306 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Doc: add a page describing what multiplexing is and how it worksJake Petroules2017-10-231-2/+58
| | | | | | | | | | | | | | Change-Id: I98415837ff441312333b3b038f3989397f505215 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Document how to target common platformsLeena Miettinen2017-10-2316-0/+726
| | | | | | | | | | | | | | Task-number: QBS-1183 Change-Id: I53f1a8f44f5ea727c797a8cf3c37948ac7fc3fea Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Merge 1.10 into masterChristian Kandeler2017-10-201-1/+1
|\| | | | | | | Change-Id: I76e1f0c4a80fe1840311874e8ec63c8e17667473
| * Allow the qbs.Xml extension to work in JavaScript filesJake Petroules2017-10-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We must return a valid object. Also, make the constructors of XmlDomDocument and XmlDomNode members of the returned object instead of polluting the global scope. [ChangeLog] XmlDomDocument and XmlDomElement are deprecated and will be removed in the 1.12 release. Use the names Xml.DomDocument and Xml.DomElement instead, which are also now available in JavaScript files as well as in a QML context. Change-Id: I82e3e33c52ac7c8fdf9ba9c27491088d643b07f7 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Update man pageChristian Kandeler2017-10-171-3/+3
|/ | | | | Change-Id: I51585643f09568ccf5606e62ccb750bb14d09ff1 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Doc: How to apply C/C++ preprocessor macros to a subset of product filesLeena Miettinen2017-10-051-0/+45
| | | | | Change-Id: I0b78fbd42521af825ff39a5d7ed6aa6c1a1a7a70 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-23 05:32:03 +0000