aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@digia.com>2014-05-09 17:17:42 +0200
committerChristian Kandeler <christian.kandeler@digia.com>2014-05-13 10:40:53 +0200
commit6d5de545c4e67289f973cf6ba9bdbbaeb4eb4a99 (patch)
tree275df0914bd1e47fc0120ce5da9857c4cf690e84 /doc
parent33f0e83c0cd2c2f149f2b03ac7cb4ba9dd22fb1a (diff)
Introduce sensible build directory values.
Currently, all products share the same build directory, and rules are responsible for making their artifact file paths unique, which is annoying for module authors and introduces lots of code duplication. Instead, make the product build directories unique and let these directories be the base directory of relative artifact file paths. Also export the top-level build dir as project.buildDirectory to the JavaScript side so rules can refer to that one if necessary. Task-number: QBS-567 Change-Id: I257d37cad01ec6dece3e214799b917149677d80c Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/items/product.qdoc11
-rw-r--r--doc/reference/items/project.qdoc5
-rw-r--r--doc/reference/items/rule.qdoc2
3 files changed, 12 insertions, 6 deletions
diff --git a/doc/reference/items/product.qdoc b/doc/reference/items/product.qdoc
index 295b3df67..f973d2b8c 100644
--- a/doc/reference/items/product.qdoc
+++ b/doc/reference/items/product.qdoc
@@ -97,8 +97,9 @@
\row
\li destinationDirectory
\li string
- \li "."
- \li The directory where the target artifacts will be located. Relative to the build directory.
+ \li product.buildDirectory
+ \li The directory where the target artifacts will be located. If a relative path is
+ given, the base directory will be \c project.buildDirectory.
\row
\li files
\li stringList
@@ -132,7 +133,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 cannot be changed by the user:
\table
\header
@@ -141,12 +142,12 @@
\li Description
\row
\li buildDirectory
- \li string
+ \li path
\li The build directory for this product. This is the directory where generated files
are placed.
\row
\li sourceDirectory
- \li string
+ \li path
\li The source directory for this product. This is the directory of the file where this
product is defined.
\endtable
diff --git a/doc/reference/items/project.qdoc b/doc/reference/items/project.qdoc
index f2a4710d1..40fd7e9de 100644
--- a/doc/reference/items/project.qdoc
+++ b/doc/reference/items/project.qdoc
@@ -62,6 +62,11 @@
\li Default
\li Description
\row
+ \li buildDirectory
+ \li path
+ \li n/a
+ \li The build directory of the top-level project. This property is read-only.
+ \row
\li name
\li string
\li basename of the file the project is defined in
diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/rule.qdoc
index 91dcc6137..d594015c5 100644
--- a/doc/reference/items/rule.qdoc
+++ b/doc/reference/items/rule.qdoc
@@ -51,7 +51,7 @@
Artifact {
fileTags: ['obj']
- fileName: '.obj/' + product.name + '/' + input.baseDir + '/' + input.fileName + '.o'
+ fileName: '.obj/' + input.baseDir + '/' + input.fileName + '.o'
}
prepare: {