1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
/*!
\contentspage list-of-modules.html
\page qbs-module.html
\ingroup list-of-modules
\title Module qbs
\since 1.0
\brief Comprises general properties.
The \c qbs module is implicitly loaded in every product. It contains properties of the current
build environment, independent of the used programming languages and toolchains.
\section1 General Properties
\table
\header
\li Property
\li Type
\li Since
\li Default
\li Description
\row
\li buildVariant
\li \c{string}
\li 1.0
\li \c{"debug"}
\li Contains the name of the build variant for the current build.
\row
\li debugInformation
\li \c bool
\li 1.0
\li \c{true} for debug builds, \c{false} otherwise
\li Specifies whether to generate debug information.
\row
\li enableDebugCode
\li \c bool
\li 1.0
\li \c{true} for debug builds, \c{false} otherwise
\li Specifies whether to compile debug code in the product.
This is typically enabled for debug builds and disabled for release builds.
\row
\li optimization
\li \c{string}
\li 1.0
\li \c{"none"} for debug builds, \c{"fast"} for release builds
\li Specifies the general type of optimization that should be performed by all toolchains.
Allowed values: \c{"none"}, \c{"fast"}, \c{"small"}
\row
\li targetOS
\li \c{stringList}
\li 1.0
\li \c{undefined}
\li Specifies the OS you want to build the project for. This is typically set in a profile.
Possible values include one or more of the following:
\c{"aix"},
\c{"android"},
\c{"blackberry"},
\c{"bsd"},
\c{"bsd4"},
\c{"bsdi"},
\c{"cygwin"},
\c{"darwin"},
\c{"dgux"},
\c{"dynix"},
\c{"freebsd"},
\c{"hpux"},
\c{"hurd"},
\c{"integrity"},
\c{"ios"},
\c{"ios-simulator"},
\c{"irix"},
\c{"linux"},
\c{"lynx"},
\c{"macos"},
\c{"msdos"},
\c{"nacl"},
\c{"netbsd"},
\c{"openbsd"},
\c{"os2"},
\c{"os2emx"},
\c{"osf"},
\c{"qnx"},
\c{"qnx6"},
\c{"reliant"},
\c{"sco"},
\c{"solaris"},
\c{"symbian"},
\c{"ultrix"},
\c{"unix"},
\c{"unixware"},
\c{"vxworks"},
\c{"windows"},
\c{"windowsce"},
\c{"windowsphone"},
\c{"winrt"}
\row
\li architecture
\li \c{string}
\li 1.0
\li \c{undefined}
\li Specifies the target platform's processor architecture. \c{undefined} indicates that
the target platform is architecture-independent (for example the CLR or JVM).
This is typically set in a profile.
Commonly used values are: \c{"x86"}, \c{"x86_64"} and \c{"arm"}.
\row
\li toolchain
\li \c{stringList}
\li 1.0
\li \c{undefined}
\li Specifies the attributes of the toolchain that is going to be used for this build.
Typical values include: \c{"gcc"}, \c{"llvm"}, \c{"clang"}, \c{"mingw"}, \c{"msvc"}
\row
\li sysroot
\li \c{string}
\li 1.0
\li \c{undefined}
\li Specifies the sysroot of the target platform.
This property is typically set in a profile for cross-compiling.
\row
\li pathListSeparator
\li \c{string}
\li 1.0
\li \c{";"} on Windows,
\c{":"} on Unix
\li Holds the platform-specific separator for path list that is used in environment
variables or other contexts.
\row
\li nullDevice
\li \c{string}
\li 1.4.2
\li \c{"NUL"} on Windows,
\c{"/dev/null"} on Unix
\li Holds the platform-specific file path corresponding to the null device.
\row
\li shellPath
\li \c{path}
\li 1.5
\li \c{"%COMSPEC%"} on Windows,
\c{"/bin/sh"} on Unix
\li Holds the platform-specific file path corresponding to the command line interpreter.
On Windows this is the path to \c{cmd.exe}, which is held in the \c{COMSPEC}
environment variable - typically \c{C:/Windows/System32/cmd.exe},
and on Unix-like platforms this is \c{/bin/sh}.
\endtable
\section1 Environment Properties
This section lists constant, read-only properties set by \QBS internally.
These properties should not be overridden.
\table
\header
\li Property
\li Type
\li Since
\li Default
\li Description
\row
\li hostOS
\li \c{stringList} (read only)
\li 1.0
\li \c{undefined}
\li This property is set by \QBS internally and specifies the OS \QBS is running on.
The possible values for this property are the values of \c targetOS, though some may not
be supported.
\row
\li hostOSVersion
\li \c{string} (read only)
\li 1.2
\li \c{undefined}
\li The host operating system version. Currently only defined for Windows and Apple
platforms. Consists of two or three numbers separated by dots, for instance "10.9" or
"6.3.9600".
\row
\li hostOSBuildVersion
\li \c{string} (read only)
\li 1.2
\li \c{undefined}
\li The host operating system's build version. Currently only defined for Windows and Apple
platforms. On Windows, this is the 4 or 5 digit Windows build number and is equivalent
to \c versionPatch. On Apple platforms, this is a standard build number in the Apple
versioning scheme, for instance "13C64".
\row
\li hostOSVersionMajor
\li \c{int} (read only)
\li 1.2
\li \c{hostOSVersionParts[0]}
\li The host operating system major version.
\row
\li hostOSVersionMinor
\li \c{int} (read only)
\li 1.2
\li \c{hostOSVersionParts[1]}
\li The host operating system minor version.
\row
\li hostOSVersionParts
\li \c{list} (read only)
\li 1.2
\li \c{empty}
\li The host operating system version as a list.
For instance, Windows 8.1 (version 6.3.9600) would correspond to a value of
\c[6, 3, 9600].
\row
\li hostOSVersionPatch
\li \c{int} (read only)
\li 1.2
\li \c{hostOSVersionParts[2]}
\li The host operating system patch level.
\row
\li version
\li \c{string} (read only)
\li 1.4.1
\li
\li Version number of \QBS as a string, i.e. "1.4.1".
\row
\li versionMajor
\li \c{int} (read only)
\li 1.4.1
\li
\li Major version number of \QBS.
\row
\li versionMinor
\li \c{int} (read only)
\li 1.4.1
\li
\li Minor version number of \QBS.
\row
\li versionPatch
\li \c{int} (read only)
\li 1.4.1
\li
\li Patch version number of \QBS.
\endtable
\section1 Installation Properties
This section lists properties specific to the \QBS installation mechanism.
See \l{Installing Files} for more information.
\table
\header
\li Property
\li Type
\li Since
\li Default
\li Description
\row
\li install
\li \c{bool}
\li 1.0
\li \c{false}
\li Specifies whether to install a certain set of files.
This is typically set in a \c{Group} item to mark a number of files as installable.
\note Artifacts for which this property is enabled automatically receive the file tag
"installable". This is useful for writing packaging-related rules.
\row
\li installSourceBase
\li \c{string}
\li 1.4
\li see below
\li Specifies the base directory of the local files that are going to be installed. The
source base directory is omitted from the target directory path specified in
\c{installDir}. The default value of this property is the directory of the current file
to be installed, relative to the product's source directory.
\row
\li installDir
\li \c{string}
\li 1.0
\li \c{undefined}
\li Specifies the installation directory for the files of a product or a \c{Group}. The
value of this property is a path that is relative to \c installPrefix.
\row
\li installPrefix
\li \c{string}
\li 1.1
\li \c{empty}
\li Specifies the global installation prefix. It is implicitly prepended to all values of
\c installDir. The \c installPrefix itself is relative to the \c installRoot in the
context of installation.
\row
\li installRoot
\li \c{string}
\li 1.4
\li \c{<build dir>/install-root}
\li Specifies the global installation root. It is implicitly prepended to all values
of \c installPrefix in the context of installation.
\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.
\endtable
*/
|
