← Back to branch summary

~bzoltan/kubuntu-packaging/decouple_cmake_plugin

« back to all changes in this revision

Viewing changes to src/shared/qbs/doc/reference/modules/qbs-module.qdoc

  • Committer: Timo Jyrinki
  • Date: 2013-11-15 12:25:23 UTC
  • mfrom: (1.1.28)
  • Revision ID: timo.jyrinki@canonical.com-20131115122523-i2kyamsu4gs2mu1m
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/shared/qbs/doc/reference/modules/qbs-module.qdoc
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the Qt Build Suite.
 
7
**
 
8
** Commercial License Usage
 
9
** Licensees holding valid commercial Qt licenses may use this file in
 
10
** accordance with the commercial license agreement provided with the
 
11
** Software or, alternatively, in accordance with the terms contained in
 
12
** a written agreement between you and Digia.  For licensing terms and
 
13
** conditions see http://qt.digia.com/licensing.  For further information
 
14
** use the contact form at http://qt.digia.com/contact-us.
 
15
**
 
16
** GNU Lesser General Public License Usage
 
17
** Alternatively, this file may be used under the terms of the GNU Lesser
 
18
** General Public License version 2.1 as published by the Free Software
 
19
** Foundation and appearing in the file LICENSE.LGPL included in the
 
20
** packaging of this file.  Please review the following information to
 
21
** ensure the GNU Lesser General Public License version 2.1 requirements
 
22
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
23
**
 
24
** In addition, as a special exception, Digia gives you certain additional
 
25
** rights.  These rights are described in the Digia Qt LGPL Exception
 
26
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 
27
**
 
28
****************************************************************************/
 
29
 
 
30
/*!
 
31
    \contentspage list-of-modules.html
 
32
    \page qbs-module.html
 
33
    \ingroup list-of-modules
 
34
 
 
35
    \title Module qbs
 
36
    \brief Comprises general properties.
 
37
 
 
38
    The \c qbs module is implicitly loaded in every product. It contains properties of the current
 
39
    build environment, independent of the used programming languages and toolchains.
 
40
 
 
41
 
 
42
    \section1 buildVariant
 
43
 
 
44
    \table
 
45
    \row    \li \b{Type:}            \li \c{string}
 
46
    \row    \li \b{Default:}         \li \c{"debug"}
 
47
    \endtable
 
48
 
 
49
    Contains the name of the build variant for the current build.
 
50
 
 
51
 
 
52
    \section1 debugInformation
 
53
 
 
54
    \table
 
55
    \row    \li \b{Type:}     \li \c bool
 
56
    \row    \li \b{Default:}  \li \c{true} for debug builds, \c{false} otherwise
 
57
    \endtable
 
58
 
 
59
    Specifies whether to generate debug information.
 
60
 
 
61
 
 
62
    \section1 enableDebugCode
 
63
 
 
64
    \table
 
65
    \row    \li \b{Type:}     \li \c bool
 
66
    \row    \li \b{Default:}  \li \c{true} for debug builds, \c{false} otherwise
 
67
    \endtable
 
68
 
 
69
    Specifies whether to compile debug code in the product.
 
70
    This is typically enabled for debug builds and disabled for release builds.
 
71
 
 
72
 
 
73
    \section1 optimization
 
74
 
 
75
    \table
 
76
    \row    \li \b{Type:}            \li \c{string}
 
77
    \row    \li \b{Allowed Values:}  \li \c{"none"}, \c{"fast"}, \c{"small"}
 
78
    \row    \li \b{Default:}         \li \c{"none"} for debug builds, \c{"fast"} for release builds
 
79
    \endtable
 
80
 
 
81
    Specifies the general type of optimization that should be performed by all toolchains.
 
82
 
 
83
 
 
84
    \section1 hostOS
 
85
 
 
86
    \table
 
87
    \row    \li \b{Type:}            \li \c{stringList} (read only)
 
88
    \endtable
 
89
 
 
90
    This property is set by qbs internally and specifies the OS qbs is running on.
 
91
    The possible values for this property are the values of \c targetOS,
 
92
    though some may not be supported.
 
93
 
 
94
 
 
95
    \section1 targetOS
 
96
 
 
97
    \table
 
98
    \row    \li \b{Type:}            \li \c{stringList}
 
99
    \row    \li \b{Possible Values:} \li one or more of:
 
100
            \c{"aix"},
 
101
            \c{"android"},
 
102
            \c{"blackberry"},
 
103
            \c{"bsd"},
 
104
            \c{"bsd4"},
 
105
            \c{"bsdi"},
 
106
            \c{"cygwin"},
 
107
            \c{"darwin"},
 
108
            \c{"dgux"},
 
109
            \c{"dynix"},
 
110
            \c{"freebsd"},
 
111
            \c{"hpux"},
 
112
            \c{"hurd"},
 
113
            \c{"integrity"},
 
114
            \c{"ios"},
 
115
            \c{"ios-simulator"},
 
116
            \c{"irix"},
 
117
            \c{"linux"},
 
118
            \c{"lynx"},
 
119
            \c{"osx"},
 
120
            \c{"msdos"},
 
121
            \c{"nacl"},
 
122
            \c{"netbsd"},
 
123
            \c{"openbsd"},
 
124
            \c{"os2"},
 
125
            \c{"os2emx"},
 
126
            \c{"osf"},
 
127
            \c{"qnx"},
 
128
            \c{"qnx6"},
 
129
            \c{"reliant"},
 
130
            \c{"sco"},
 
131
            \c{"solaris"},
 
132
            \c{"symbian"},
 
133
            \c{"ultrix"},
 
134
            \c{"unix"},
 
135
            \c{"unixware"},
 
136
            \c{"vxworks"},
 
137
            \c{"windows"},
 
138
            \c{"windowsce"},
 
139
            \c{"windowsphone"},
 
140
            \c{"winrt"}
 
141
    \endtable
 
142
 
 
143
    Specifies the OS you want to build the project for.
 
144
    This is typically set in a profile.
 
145
 
 
146
 
 
147
    \section1 architecture
 
148
 
 
149
    \table
 
150
    \row    \li \b{Type:}            \li \c{string}
 
151
    \endtable
 
152
 
 
153
    Specifies the target platform's processor architecture.
 
154
    This is typically set in a profile.
 
155
    Currently used values are: \c{"x86"}, \c{"x86_64"} and \c{"arm"}.
 
156
 
 
157
 
 
158
    \section1 endianness
 
159
 
 
160
    \table
 
161
    \row    \li \b{Type:}            \li \c{string}
 
162
    \row    \li \b{Allowed Values:}  \li \c{"big"}, \c{"little"}, \c{"mixed"}
 
163
    \row    \li \b{Default:}         \li \c{undefined}
 
164
    \endtable
 
165
 
 
166
    Specifies the endianness of the target platform's processor architecture.
 
167
 
 
168
 
 
169
    \section1 toolchain
 
170
 
 
171
    \table
 
172
    \row    \li \b{Type:}            \li \c{stringList}
 
173
    \row    \li \b{Allowed Values:}  \li \c{"gcc"}, \c{"llvm"}, \c{"clang"}, \c{"mingw"}, \c{"msvc"}
 
174
    \endtable
 
175
 
 
176
    Specifies the attributes of the toolchain that is going to be used for this build.
 
177
 
 
178
 
 
179
    \section1 sysroot
 
180
 
 
181
    \table
 
182
    \row    \li \b{Type:}            \li \c{string}
 
183
    \row    \li \b{Default:}         \li \c{undefined}
 
184
    \endtable
 
185
 
 
186
    Specifies the sysroot of the target platform. This property is typically set in a profile
 
187
    for cross-compiling.
 
188
 
 
189
 
 
190
    \section1 install
 
191
 
 
192
    \table
 
193
    \row    \li \b{Type:}            \li \c{bool}
 
194
    \row    \li \b{Default:}         \li \c{false}
 
195
    \endtable
 
196
 
 
197
    Specifies whether to install a certain set of files.
 
198
    This is typically set in a \c{Group} item to mark a number of files as installable.
 
199
 
 
200
 
 
201
    \section1 installDir
 
202
 
 
203
    \table
 
204
    \row    \li \b{Type:}            \li \c{string}
 
205
    \row    \li \b{Default:}         \li \c{undefined}
 
206
    \endtable
 
207
 
 
208
    Specifies the installation directory for the files of a product or a \c{Group}. The value of
 
209
    this property is a path that is relative to \c installPrefix.
 
210
 
 
211
    \section1 installPrefix
 
212
 
 
213
    \table
 
214
    \row    \li \b{Type:}            \li \c{string}
 
215
    \row    \li \b{Default:}         \li \c{empty}
 
216
    \endtable
 
217
 
 
218
    Specifies the global installation prefix. It is implicitly prepended to all values
 
219
    of \c installDir. The \c installPrefix itself is relative to the install root, which is not
 
220
    a property of qbs, but an external installation parameter.
 
221
 
 
222
    \section1 pathListSeparator
 
223
 
 
224
    \table
 
225
    \row    \li \b{Type:}            \li \c{string}
 
226
    \endtable
 
227
 
 
228
    Holds the platform-specific separator for path list that is used in environment variables or
 
229
    other contexts. E.g. on Windows is this \c{";"}, on Unix derivatives \c{":"}.
 
230
*/
 
231