aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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 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>
* 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>
* 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>
* 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>
* Doc: Add a how-to for creating modules for 3rd party librariesLeena Miettinen2017-10-051-0/+56
| | | | | | | Task-number: QBS-1191 Change-Id: I63199bc85bed43841e97908fcff0268211ba86c0 Reviewed-by: Jake Petroules <jake.petroules@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Remove pointless option for update-timestamps commandChristian Kandeler2017-10-051-2/+1
| | | | | | | Also fix help output and CLI documentation. Change-Id: I45229809ea2f088628f1b512200fe3c8e99f4132 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Improve dump-nodes-tree commandChristian Kandeler2017-10-051-7/+1
| | | | | | | | | | | | - Remove redundant output also for rule nodes (rather than just for artifacts). - Strip down the list of supported options. Some of the ones we listed there made no sense for this command. - Fix help output and CLI documentation. Change-Id: If13667d48e12de99df3bb19a4f82f97aa9256d02 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* Improve status commandChristian Kandeler2017-10-051-6/+1
| | | | | | | | | | - Indent also the untracked and missing file lists. - Remove pointless options. - Fix help output and CLI documentation. Change-Id: Iba23ad7fc3366cfac02b255b17cca9127556b9bb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* Doc: Describe porting qmake projects to QbsLeena Miettinen2017-10-052-5/+517
| | | | | | Task-number: QBS-407 Change-Id: Ia2f59288e2f9aca0d9fed800ee52c4082cf18d07 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Fix shell commandChristian Kandeler2017-10-051-16/+0
| | | | | | | | | | | | | - Use the build environment rather than the system environment (that's the whole point of the command). - Remove the need for a specific product. - Use a more sensible prompt. - Strip down the list of supported options. - Fix typo in comment. Change-Id: I8e4040d44ab6a95e60a7265e05d5b66fb3dfa878 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Remove --jobs from the list of options for the resolve commandChristian Kandeler2017-10-051-1/+0
| | | | | | | | | This command does not spawn concurrent jobs. Change-Id: I4bc605b31ff94e463f1c65d98379843b50c36ec4 Reviewed-by: Jake Petroules <jake.petroules@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Doc: Describe using Qbs Settings dialog to manage settingsLeena Miettinen2017-10-041-0/+23
| | | | | Change-Id: Ib96e452ba459be449fdd30edef002bccf51fab3e Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Create a CLI referenceLeena Miettinen2017-10-0424-34/+1908
| | | | | | | | | | | | | Each command is described on a separate page. Option and parameter descriptions are fetched from include files. \group and \ingroup commands are used to create a table that shows the CLI commands and short descriptions (from \brief commands). Task-number: QBS-947 Change-Id: I956c0e029f87e98162e03206a79baef604f1d55e Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Merge "Merge remote-tracking branch 'origin/1.9'"Joerg Bornemann2017-09-261-1/+1
|\
| * Merge remote-tracking branch 'origin/1.9'Joerg Bornemann2017-09-261-1/+1
| |\ | | | | | | | | | Change-Id: I40c1ea23e7351deac715958783158c089e65a02d
| | * Doc: Update the cpp module exampleJoerg Bornemann2017-09-251-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Remove the outdated property precompiledHeader from the simplified cpp module. Use includePaths as example instead. Change-Id: Ib51d97a10d4853b09dc475ad1257b7888758c907 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | | Introduce Module.priorityJoerg Bornemann2017-09-261-0/+7
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the property Module.priority to be able to define an order of module instances. This is used to resolve conflicts in module instances. If there is more than one module instance available, the one with the highest numerical priority is chosen. [ChangeLog] The property Module.priority was added to provide a mechanism to resolve conflicts in module instances. Task-number: QBS-61 Change-Id: I6aeae91be742bb11a61345bb890992697bdf0a23 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Merge remote-tracking branch 'origin/1.9'Joerg Bornemann2017-09-181-0/+8
|\| | | | | | | Change-Id: I962adbe6a7a805e9250807a31e87580a86b1d067
| * Add missing documentation for cpp.endianness propertyJake Petroules2017-09-161-0/+8
| | | | | | | | | | | | | | Amends 38bb125aae Change-Id: Ie9dec55245554e3c6639b66c7814e904c48b24b1 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Update supported platforms and build requirementsLeena Miettinen2017-09-151-2/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | - Synchronize required versions of tools with Qt Creator 4.4, where applicable. - List currently tested platforms. - Move the instructions from the README to the Qbs Manual and add the URL to product documentation. Task-number: QBS-1071 Change-Id: I5d710972bd6b686b18f02a1bd7db5e8356e09b7a Reviewed-by: Jake Petroules <jake.petroules@qt.io> Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* | Doc: Describe the concurrent jobs (-j) option for building applicationsLeena Miettinen2017-09-141-3/+21
| | | | | | | | | | Change-Id: Iaa2d97d9c2cda7ccd435124a916f558486bb8d80 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Doc: Describe main Qbs features in "Introduction"Leena Miettinen2017-09-141-7/+218
| | | | | | | | | | Change-Id: I8d2405156712562620ac79f03fb8dece87c961d3 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Doc: Update the "Running Applications" topicLeena Miettinen2017-09-081-5/+5
| | | | | | | | | | | | | | | | | | | | Remove reference to Qt 4.8 and setting the PATH. Add a general statement about running apps. Use Qt Creator as the example project, because it contains several products. Change-Id: I31756e5d33a6783ae94bc2edf9dff3b5c5dc8ad3 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Change type of java.jdkPath from path to stringJoerg Bornemann2017-09-071-1/+1
| | | | | | | | | | | | | | | | The JDK is usually not located below the project root. A path property is not useful here. Change-Id: I2e150d0dfe0e9d925ff242b4fa46a606d750753e Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Doc: Add the "modules" prefix to the to "qbs build" command exampleLeena Miettinen2017-09-061-1/+1
| | | | | | | | | | Change-Id: Id27786a979578fa91ff83e4cb245b9528b0e3246 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Doc: make the profile example more realisticJake Petroules2017-09-061-3/+3
| | | | | | | | | | | | | | | | | | targetOS with linux but not unix will result in some weird behavior. arm probably means armv4, so let's say armv7a instead. arm-linux-gnueabi- is a realistic toolchain prefix. Change-Id: Id1f720d78b381201d006828cd331c18e80ee0ed7 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Introduce property cpp.variantSuffixChristian Kandeler2017-09-011-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | This property existed already, but was only used for Darwin. It is now fully functional and has proper platform-specific default values. [ChangeLog] Debug variants of libraries now get a name suffix on Darwin and Windows when multiplexing over qbs.buildVariants. Overriding is possible via cpp.variantSuffix. Change-Id: I5763f9641ead4f6335ab1f1800b9929bf84279e3 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Merge 1.9 into masterChristian Kandeler2017-09-015-0/+129
|\| | | | | | | Change-Id: I9229fc79aeadfbdfe1b7a4817ad58d42fb0a77a0
| * Document the relevant file tags of the ib moduleJake Petroules2017-08-302-0/+54
| | | | | | | | | | | | Task-number: QBS-934 Change-Id: Iab702d0f450bf4335030f5f927cbf4b92cc61652 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Document the relevant file tags of the wix moduleJake Petroules2017-08-291-0/+43
| | | | | | | | | | | | | | Task-number: QBS-934 Change-Id: I351fcaead747bc7fab4eee11d53998c8c77d2150 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Document the relevant file tags of the nsis moduleJake Petroules2017-08-291-0/+26
| | | | | | | | | | | | | | Task-number: QBS-934 Change-Id: I7e68da609dbf57f7d280335511d9b3a9fe6e9083 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Document the relevant file tags of the bundle moduleJake Petroules2017-08-291-0/+6
| | | | | | | | | | | | | | Task-number: QBS-934 Change-Id: I1abd73c9ff41ddc1b65a7b50cbd383c06cd6a005 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Add a minimal man pageChristian Kandeler2017-08-296-0/+164
| | | | | | | | | | | | | | | | | | | | It contains the list of commands and a link to our online documentation. Auto-generated via GNU's help2man from the application's help output. [ChangeLog] Added a man page Change-Id: Ie7101b0941f466642d7ec89a12c4e490d6d0e16f Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* | Merge 1.9 into masterChristian Kandeler2017-08-282-0/+214
|\| | | | | | | Change-Id: I5320b7c62d6a80089df75c2caca79c15602c01e5
| * Add code attribution documentationKai Koehne2017-08-242-0/+214
| | | | | | | | | | | | | | | | | | | | Manually add the documentation generated by qtattributionsscanner out of the qt_attribution.json files. We can generate these on the fly once we can depend on Qt 5.8. Change-Id: Ia898044e854d473ae93ba07a9ff21e043ba29a29 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Revert "Generate code attribution documentation"Christian Kandeler2017-08-236-57/+3
| | | | | | | | | | | | | | | | | | This reverts commit c75285b0b6c2d10a08acdc78c0554831c42c52c6. The qtattributionscanner was introduced in Qt 5.8, while our minimum Qt version is 5.6. Change-Id: I444058236e946584fc133a9a7ee93fa1a9969b94 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
| * Generate code attribution documentationKai Koehne2017-08-236-3/+57
| | | | | | | | | | Change-Id: I692efc667d5e9713afee0cd2ee155ac24ed3de56 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Introduce the cpufeatures moduleChristian Kandeler2017-08-281-0/+191
| | | | | | | | | | | | | | | | | | Provides an abstraction for the respective compiler flags. The initial set of properties is the superset of what Qt can configure and what MSVC supports. Change-Id: I1be90361f2f104a55d2a784a69625396680b0713 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* | Introduce property cpp.discardUnusedDataChristian Kandeler2017-08-251-0/+8
| | | | | | | | | | | | | | | | | | Maps to linker options that strip unneeded symbols or sections. [ChangeLog] Added new property cpp.discardUnusedData. Change-Id: I2f2c7f449e9ac426af859fac4d1e3b941be2a2ab Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* | Add TextFile.Append for appending data to text filesJoerg Bornemann2017-08-211-1/+3
| | | | | | | | | | | | | | | | [ChangeLog] The TextFile.OpenMode TextFile.Append was added to enable appending data to text files. Change-Id: I431e8652033d632fe6a85dafc7dc8bcd5e6d0279 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Introduce the vcs moduleChristian Kandeler2017-08-181-0/+99
| | | | | | | | | | | | | | | | | | | | | | | | Every once in a while, users ask how they can best achieve to get access to their current git HEAD, so we provide a module that does it for them. [ChangeLog] Added the vcs module to provide VCS repository information. Git and Subversion are supported initially. Change-Id: Ib425547bf9f04406cda35bf81bcb878f6ea4b9ce Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* | Make sure all files in the repository are shown in the Qbs project treeJake Petroules2017-08-161-0/+6
| | | | | | | | | | | | | | | | This is helpful when working with IDEs because it enables Find functions to work better, and avoids context switching to other editors. Change-Id: I419ab440bd2b43eaf712b2cc498cc6c2d6d9e21b Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Doc: Describe generating Clang compilation databasesLeena Miettinen2017-08-161-13/+26
| | | | | | | | | | | | | | | | Reorganize the Generators topic accordingly. Task-number: QBS-1166 Change-Id: I003d286ae92407bf2af0f22431a2dc9acd1caef7 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Merge 1.9 into masterChristian Kandeler2017-08-141-0/+12
|\| | | | | | | Change-Id: I6da76b0a53bf87105c4e7b48724d9760cb68e831
| * Add reference pages to index.htmlKai Koehne2017-08-041-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | The reference is arguably the most important part, so it makes sense to link also to sub-sections from the main page. One of the issues is that the sub-pages are not properly 'linked' with nextpage and previouspage. Anyhow, this should not block us from making the index page more useful. Change-Id: I1c80345795c1df294d07f7a31b613a24df341cb3 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* | Make a Group's prefix default to the one of the parent groupChristian Kandeler2017-08-141-4/+4
| | | | | | | | | | | | | | | | | | | | This should be the most sensible default. [ChangeLog] Groups without a prefix now inherit the one of the parent group. Change-Id: Ieee94d1a0f5cb073def8db9feff8c1ca5ea1eacf Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* | Automatically determine built-in compiler definesJake Petroules2017-08-111-5/+15
| | | | | | | | | | | | | | | | This provides users with access to the full list of macros defined by the MSVC, GCC, Clang, or MinGW compiler in use. Change-Id: I6e7f6841bbc18aed13958724b268283d97b17320 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-09 22:01:51 +0000