aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@qt.io>2017-06-09 15:22:22 +0200
committerChristian Kandeler <christian.kandeler@qt.io>2017-06-09 15:58:38 +0000
commit8ffd8404edc0fbbebdae06832a404e411a690e28 (patch)
tree67c905e262e7bb7f69e009b9c8566acc0d0ce208
parent7ccc08f33153cd3093081567ac653e371759d69a (diff)
Document how to override property values from the command line
Change-Id: Icaef6daa3b98cf0a76e78341d43f797230fe8701 Reviewed-by: Stephan Gatzka <stephan.gatzka@gmail.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
-rw-r--r--doc/qbs.qdoc22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc
index 3a3d322ab..f9e6025d1 100644
--- a/doc/qbs.qdoc
+++ b/doc/qbs.qdoc
@@ -592,6 +592,28 @@
\endtable
+ \section1 Overriding Property Values from the Command Line
+
+ Property values set in project files or profiles can be overridden on the command line.
+ The syntax is \c{<prefix>.<prop-name>:<prop-value>}. The following command lines
+ demonstrate how to set different kinds of properties:
+ \code
+ $ qbs projects.someProject.projectProperty:false # set a property of a project
+ $ qbs products.someProduct.productProperty:false # set a property of a product
+ $ qbs modules.cpp.treatWarningsAsErrors:true # set a module property for all products
+ \endcode
+
+ Property values on the command line can also be expressed in JavaScript form, the same way
+ as you would write them in a project file. Make sure to take care of proper
+ quoting, so that the shell does not interpret any of the values itself. Properties of type
+ \c stringList can also be provided as comma-separated values, if none of the strings contain
+ special characters:
+ \code
+ $ qbs projects.someProject.listProp:'["a", "b", "c"]'
+ $ qbs projects.someProject.listProp:a,b,c # same as above
+ $ qbs projects.someProject.listProp:'["a b", "c"]' # no CSV equivalent
+ \endcode
+
\section1 File Tags and Taggers
\QBS itself knows nothing about C++ files or file extensions. All source files