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
|
/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\previouspage creator-build-settings-qmake.html
\page creator-build-settings-qbs.html
\nextpage creator-build-settings-meson.html
\title Qbs Build Configuration
\image qtcreator-build-settings-qbs.png "Qbs build settings"
Qbs builds projects in the directory specified in the
\uicontrol {Build Directory} field.
In the \uicontrol {Tooltip in target selector} field, you can enter text
that is displayed as a tooltip when you hover the mouse over the build
configuration in the \l{Building for Multiple Platforms}{kit selector}.
You can enter a name for the build configuration in the
\uicontrol {Configuration name} field.
If debug info is being generated, you can have it placed into separate
files, rather than embedded into the binary, by selecting
\uicontrol Enable in the \uicontrol {Separate debug info} field. For
more information, see \l{Using the Performance Analyzer}. To use default
settings, select \uicontrol {Leave at Default}.
For more information about the QML debugging options, see
\l{Setting Up QML Debugging}.
For more information about configuring Qbs, see \l{Setting Up Qbs}.
\section1 Qbs Build Steps
\image creator-qbs-build-app.png "Qbs build steps"
To specify build steps for Qbs:
\list 1
\li In the \uicontrol {Build variant} field, select \uicontrol Debug to
include debug symbols in the build for debugging the application and
\uicontrol Release to create the final installation file.
\li In the \uicontrol ABIs field, select the ABIs for
the \l{Connecting Android Devices}{Android} device
architectures to build the project for.
\li In the \uicontrol {Parallel jobs} field, specify the number of
parallel jobs to use for building.
\li In the \uicontrol Properties field, specify the properties to pass
to the project. Use colons (:) to separate keys from values.
For more information, see
\l{http://doc.qt.io/qbs/language-introduction.html}
{Modules} in the Qbs Manual.
\li In the \uicontrol Flags field:
\list
\li Select \uicontrol {Keep going} to continue building when
errors occur, if possible.
\li Select \uicontrol {Show command lines} to print actual
command lines to \l{Compile Output} instead of
high-level descriptions.
\li Select \uicontrol {Force probes} to force re-execution of
the configure scripts of
\l{https://doc.qt.io/qbs/qbsprobes-qmlmodule.html}{Probes}.
\endlist
\li In the \uicontrol {Installation flags} field:
\list
\li Select \uicontrol Install to copy artifacts to their install
location after building them. This option is enabled by
default.
\note On Windows, the build will fail if the application
is running because the executable file cannot be
overwritten. To avoid this issue, you can deselect this
check box and add a \uicontrol {Qbs Install} deployment step
in the run settings that will be performed just before
running the application.
\li Select \uicontrol {Clean install root} to remove the
contents of the install root directory before the build
starts.
\li Select \uicontrol {Use default location} to install the
artifacts to the default location. Deselect the check box to
specify another location in the
\uicontrol {Installation directory} field.
\endlist
\endlist
The \uicontrol {Equivalent command line} field displays the build command
that is constructed based on the selected options.
\section1 Qbs Clean Steps
When building with Qbs, you can specify flags in \uicontrol {Clean Steps}:
\image creator-qbs-build-clean.png "Qbs clean steps"
\list
\li Select \uicontrol {Dry run} to test cleaning without executing
commands or making permanent changes to the build graph.
\li Select \uicontrol {Keep going} to continue cleaning when errors
occur, if possible.
\endlist
The \uicontrol {Equivalent command line} field displays the clean command
that is constructed based on the selected options.
*/
|
