diff options
Diffstat (limited to 'doc/reference/items')
| -rw-r--r-- | doc/reference/items/depends.qdoc | 8 | ||||
| -rw-r--r-- | doc/reference/items/filetagger.qdoc | 11 | ||||
| -rw-r--r-- | doc/reference/items/group.qdoc | 2 | ||||
| -rw-r--r-- | doc/reference/items/module.qdoc | 28 | ||||
| -rw-r--r-- | doc/reference/items/product.qdoc | 4 | ||||
| -rw-r--r-- | doc/reference/items/rule.qdoc | 2 |
6 files changed, 43 insertions, 12 deletions
diff --git a/doc/reference/items/depends.qdoc b/doc/reference/items/depends.qdoc index c181fa465..ce633e5fa 100644 --- a/doc/reference/items/depends.qdoc +++ b/doc/reference/items/depends.qdoc @@ -53,6 +53,14 @@ \li true \li Determines whether the dependency will actually be applied. \row + \li required + \li bool + \li \c true + \li Setting this property to \c false creates a \e{soft dependency}, meaning that it is not + considered an error if the given module cannot be found. In such a case, an instance of + the respective module will be created, but only the \c present property will be + available for querying, and it will be set to \c false. + \row \li name \li string \li undefined diff --git a/doc/reference/items/filetagger.qdoc b/doc/reference/items/filetagger.qdoc index 573ce86d9..42d1a21a0 100644 --- a/doc/reference/items/filetagger.qdoc +++ b/doc/reference/items/filetagger.qdoc @@ -38,11 +38,11 @@ This item maps file patterns to tags. It can be attached to a product or a module. In the latter case, its effect is the same as if it had been attached to all products having - a dependency on the respective module. For instance, the cpp module of Qbs has, among others, + a dependency on the respective module. For instance, the cpp module of \QBS has, among others, the following file tagger: \code FileTagger { - pattern: "*.cpp" + patterns: "*.cpp" fileTags: ["cpp"] } \endcode @@ -73,10 +73,11 @@ \li Default \li Description \row - \li pattern - \li string + \li patterns + \li stringList \li none - \li The pattern to match against. Supports the usual wildcards '*', '?' and '[]'. + \li The patterns to match against. Supports the usual wildcards '*', '?' and '[]'. + Neither the list itself nor any of its elements may be empty. \row \li fileTags \li list diff --git a/doc/reference/items/group.qdoc b/doc/reference/items/group.qdoc index 08c5e3a01..5c03a4c97 100644 --- a/doc/reference/items/group.qdoc +++ b/doc/reference/items/group.qdoc @@ -65,7 +65,7 @@ } \endcode When specifying files, you can use the wildcards "*", "?" and "[]", which have their usual meaning. - By default, matching files are only picked up directly from the parent directory, but you can tell Qbs to + By default, matching files are only picked up directly from the parent directory, but you can tell \QBS to consider the whole directory tree. It is also possible to exclude certain files from the list. The pattern ** used in a pathname expansion context will match all files and zero or more directories and subdirectories. diff --git a/doc/reference/items/module.qdoc b/doc/reference/items/module.qdoc index 6863ad671..a3d78dbb7 100644 --- a/doc/reference/items/module.qdoc +++ b/doc/reference/items/module.qdoc @@ -40,11 +40,26 @@ product if the product depends on (or loads) the module. A Module can be loaded by adding a dependency to it in a product. - For example, the following product will load the \c cpp module: + For example, the following product will load the \c cpp module. In addition, it will try + to load modules that may or may not exist, and in the latter case use a fallback. \code Product { Depends { name: "cpp" } - ... + Depends { + name: "awesome_module" + required: false + } + Depends { + name: "adequate_module" + condition: !awesome_module.present + required: false + } + Depends { + name: "crappy_module" + condition: !awesome_module.present && !adequate_module.present + } + + // ... } \endcode @@ -55,11 +70,18 @@ \li Default \li Description \row + \li present + \li bool + \li \c true + \li This property is read-only. Its value is \c false if and only if the respective + \c Depends item had its \c required property set to \c false and the module was + not found. + \row \li setupBuildEnvironment \li script \li \c undefined \li Script for setting up the environment in which the project is built. - Use the \c putenv and \c getenv functions to alter the environment. + Use the \c putEnv and \c getEnv functions to alter the environment. The return value of this script is ignored. \row \li setupRunEnvironment diff --git a/doc/reference/items/product.qdoc b/doc/reference/items/product.qdoc index 3340d72d8..295b3df67 100644 --- a/doc/reference/items/product.qdoc +++ b/doc/reference/items/product.qdoc @@ -50,7 +50,7 @@ The \c type property specifies what will be built (an executable). The \c files property specifies the input files (one C++ source file), and the \c Depends item pulls in the logic from the \c cpp module about how to do the necessary transformations. - For some often-used types of products, Qbs pre-defines special derived items that save + For some often-used types of products, \QBS pre-defines special derived items that save users some typing. These are: \list \li Application @@ -132,7 +132,7 @@ Info.plist files in OS X and iOS application and framework bundles, for example. \endtable - The following properties are automatically set by qbs and usually are not changed by the user: + The following properties are automatically set by \QBS and usually are not changed by the user: \table \header diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/rule.qdoc index 5339a986f..b5f553142 100644 --- a/doc/reference/items/rule.qdoc +++ b/doc/reference/items/rule.qdoc @@ -41,7 +41,7 @@ one or more artifacts (e.g. C++ linker). A \e {non-multiplex rule} creates one transformer per matching input file (e.g. C++ compiler). - As a real-world example of a non-multiplex rule, here is a simplified version of qbs' rule for + As a real-world example of a non-multiplex rule, here is a simplified version of \QBS' rule for transforming C++ sources into object files using gcc: \code Rule { |