diff options
author | Christian Kandeler <christian.kandeler@qt.io> | 2019-07-26 16:57:44 +0200 |
---|---|---|
committer | Christian Kandeler <christian.kandeler@qt.io> | 2019-07-26 16:57:44 +0200 |
commit | d46b40d27ebc9bcbdb4430893396f066e1f2d758 (patch) | |
tree | 28f269505091363139945284ec77dd2636a12290 /doc | |
parent | 7ead994c8a3e263c4cced6f54f0d959d32268454 (diff) | |
parent | 2269ddc60e47bfea459ef034ab1be112716b4764 (diff) |
Merge 1.14 into master
Change-Id: Ic632b377bf10e2b320956011e9a7d4eea99f560b
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/items/language/joblimit.qdoc | 2 | ||||
-rw-r--r-- | doc/reference/items/language/rule.qdoc | 54 | ||||
-rw-r--r-- | doc/reference/modules/cpp-module.qdoc | 12 | ||||
-rw-r--r-- | doc/reference/modules/qbs-module.qdoc | 5 |
4 files changed, 35 insertions, 38 deletions
diff --git a/doc/reference/items/language/joblimit.qdoc b/doc/reference/items/language/joblimit.qdoc index 66697ba3e..cd68bae31 100644 --- a/doc/reference/items/language/joblimit.qdoc +++ b/doc/reference/items/language/joblimit.qdoc @@ -79,7 +79,7 @@ */ /*! - \qmlproperty string JobLimit::jobCount + \qmlproperty int JobLimit::jobCount The maximum number of commands in the given \l{jobPool}{job pool} that can run concurrently. diff --git a/doc/reference/items/language/rule.qdoc b/doc/reference/items/language/rule.qdoc index 3a14c2fa6..62a32caf5 100644 --- a/doc/reference/items/language/rule.qdoc +++ b/doc/reference/items/language/rule.qdoc @@ -45,30 +45,28 @@ The following rule takes text files and replaces Windows-style line endings with their Unix-style counterparts. We will look at it one piece at a time. - \code - Rule { - multiplex: false - \endcode + \quotefromfile ../examples/rule/rule.qbs + + \skipto Rule + \printuntil multiplex: false + A \e {multiplex rule} creates one transformer that takes all input artifacts with the matching input file tag and creates one or more output artifacts. We are setting the respective property to \c false here, indicating that we want to create one transformer per input file. \note This is actually the default, so the above assignment is not required. - \code - inputs: ["txt_input"] - \endcode + + \printuntil inputs: ["txt_input"] + Here we are specifying that our rule is interested in input files that have the tag \c "txt_input". Such files could be source files, in which case you would tag them using a \l{Group}. Or they could in turn get generated by a different rule, in which case that rule would assign the file tag. The files matching the tag will be available in the \l{prepare} script under the name \c inputs (see \l{inputs and outputs}{The inputs and outputs Variables}). - \code - Artifact { - filePath: input.fileName + ".out" - fileTags: ["txt_output"] - } - \endcode + + \printuntil } + Here we are specifying that for every input file, we want to create one output file whose name is the same as the input file, but with an additional extension. Because we are giving a relative path, \QBS will prepend that path by the product's build directory. @@ -82,24 +80,8 @@ \l Artifact items. The set of output artifacts will be available in the prepare script under the name \c outputs (see \l{inputs and outputs}{The inputs and outputs Variables}). - \code - prepare: { - var cmd = new JavaScriptCommand(); - cmd.description = input.fileName + "->" + output.fileName; - cmd.highlight = "codegen"; - cmd.sourceCode = function() { - var file = new TextFile(input.filePath); - var content = file.readAll(); - file.close() - content = content.replace(/\r\n/g, "\n"); - file = new TextFile(output.filePath, TextFile.WriteOnly); - file.write(content); - file.close(); - } - return [cmd]; - } - } - \endcode + \printuntil /^\s{4}\}/ + The prepare script shown above puts everything together by creating the command that does the actual transformation of the file contents, employing the help of the \l{TextFile Service}{TextFile} class. @@ -184,6 +166,16 @@ our executable. \endlist + \section1 A Complete Example + + The following code snippet shows a single \l{Rule} within a \l{Product} and summarizes the + previous sections. + + \note The product's type is set up to the \c "txt_output" file tag to tell \QBS that the + product depends on output artifacts produced by the custom rule. Otherwise the rule would not + be executed. + + \quotefile ../examples/rule/rule.qbs */ /*! diff --git a/doc/reference/modules/cpp-module.qdoc b/doc/reference/modules/cpp-module.qdoc index f69f07239..9f554dc1c 100644 --- a/doc/reference/modules/cpp-module.qdoc +++ b/doc/reference/modules/cpp-module.qdoc @@ -1090,9 +1090,12 @@ Passes \c{-miphoneos-version-min=<version>} to the compiler. - If left undefined, compiler defaults will be used. + If set to undefined, compiler defaults will be used. - \nodefaultvalue + \note \QBS sets minimum version to \c "6.0" for \c armv7a because earlier iOS versions are + broken in recent XCode installations. + + \defaultvalue \c "6.0" for \c armv7a, \c undefined otherwise */ /*! @@ -1146,7 +1149,10 @@ If left undefined, compiler defaults will be used. - \nodefaultvalue + \note \QBS sets the minimum version to \c "6.0", because earlier tvOS + versions are not supported by recent XCode installations by default. + + \defaultvalue \c "6.0 */ /*! diff --git a/doc/reference/modules/qbs-module.qdoc b/doc/reference/modules/qbs-module.qdoc index 9e7cc8c3c..c1a0b2532 100644 --- a/doc/reference/modules/qbs-module.qdoc +++ b/doc/reference/modules/qbs-module.qdoc @@ -640,8 +640,7 @@ The architectures the product will be built for. - \defaultvalue \c{["armv5te"]} on Android, same as Xcode on Apple platforms, - otherwise equivalent to \l{qbs::architecture}{[qbs.architecture]}. + \nodefaultvalue */ /*! @@ -650,7 +649,7 @@ The build variants the product will be built for. - \defaultvalue Equivalent to \l{qbs::buildVariant}{[qbs.buildVariant]}. + \nodefaultvalue */ /*! |