aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@qt.io>2016-12-05 17:47:49 +0100
committerChristian Kandeler <christian.kandeler@qt.io>2016-12-06 10:57:08 +0000
commit71dc20dc06dd52815798d1fd480fde57a4eca42d (patch)
treeb6f0b56cfacbfa0b71d40d2b88e82f56c16711d8
parenta77be06d1ff41bdb1c5e8cdf6449b7ccff4630f5 (diff)
Doc: Clarify that qbs.installRoot is read-only within project files
Task-number: QBS-1063 Change-Id: Ic3ffc3125dac884324c9439861857c56d27a9716 Reviewed-by: Jake Petroules <jake.petroules@qt.io>
-rw-r--r--doc/reference/modules/qbs-module.qdoc3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/reference/modules/qbs-module.qdoc b/doc/reference/modules/qbs-module.qdoc
index 8b5be794e..afca54da1 100644
--- a/doc/reference/modules/qbs-module.qdoc
+++ b/doc/reference/modules/qbs-module.qdoc
@@ -320,7 +320,8 @@
\note This property is fundamentally different from \c installDir and \c installPrefix
in that it must not be visible to the code being built. In fact, the install root is
often just a temporary location used to package the binaries, which should therefore not
- assume they will be in that location at run-time.
+ assume they will be in that location at run-time. For the same reason, this property
+ must not be set from within project files.
\endtable
*/