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
|
/****************************************************************************
**
** Copyright (C) 2021 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.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\previouspage creator-debugging.html
\page creator-debugger-engines.html
\nextpage creator-debugger-operating-modes.html
\title Setting Up Debugger
The main debugger settings are associated with the
\l{glossary-buildandrun-kit}{kit} you build and run your project with. To
specify the debugger and compiler to use for each kit, select
\uicontrol Tools > \uicontrol Options > \uicontrol Kits.
You need to set up the debugger only if the automatic setup fails, because
the native debugger is missing (as is usually the case for the CDB debugger
on Windows, which you always must install yourself) or because the installed
version is not supported (for example, when your system contains no, or an
outdated version of GDB and you want to use a locally installed replacement
instead).
\note If you need to change the debugger to use for an automatically
detected \l{glossary-buildandrun-kit}{kit}, you can \uicontrol Clone the
kit and change the parameters in the clone. Make sure to select the cloned
kit for your project.
If the debugger you want to use is not automatically detected, select
\uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol Debuggers > \uicontrol Add to add it.
\note To use the debugging tools for Windows, you must install them and add
the Symbol Server provided by Microsoft to the symbol search path of the
debugger. For more information, see \l{Setting CDB Paths on Windows}.
\note To use the Free Software Foundation (FSF) version of GDB on \macos, you
must sign it and modify your \l{glossary-buildandrun-kit}{kit} settings.
This section explains the options you have for debugging C++ code and
provides installation notes for the supported native debuggers. It also
applies for code in other compiled languages such as C, FORTRAN, Ada.
For more information on the debugger modes, see
\l{Launching the Debugger in Different Modes}.
\section1 Supported Native Debugger Versions
\QC supports native debuggers when working with compiled code. On
most supported platforms, the GNU Symbolic Debugger GDB can be used. On
Microsoft Windows, when using the Microsoft tool chain, the Microsoft
Console Debugger CDB is needed. On \macos and Linux, the LLDB debugger
can be used.
The following table summarizes the support for debugging C++ code:
\table
\header
\li Platform
\li Compiler
\li Native Debugger
\row
\li Linux
\li GCC, ICC
\li GDB, LLDB
\row
\li Unix
\li GCC, ICC
\li GDB
\row
\li \macos
\li GCC, Clang
\li LLDB, FSF GDB (experimental)
\row
\li Windows/\MinGW
\li GCC
\li GDB
\row
\li Windows/MSVC
\li Microsoft Visual C++ Compiler
\li Debugging Tools for Windows/CDB
\endtable
\section2 Supported GDB Versions
Starting with version 3.1, \QC requires the Python scripting extension. GDB
builds without Python scripting are not supported anymore and will not work.
The minimum supported version is GDB 7.5 using Python version 2.7, or 3.3,
or newer.
For remote debugging using GDB and GDB server, the minimum supported version
of GDB server on the target \l{glossary-device}{device} is 7.0.
\section2 Supported CDB Versions
All versions of CDB targeting platforms supported by Qt are supported by
\QC.
\section2 Supported LLDB Versions
The LLDB native debugger has similar functionality to the GDB debugger. LLDB
is the default debugger in Xcode on \macos for supporting C++ on the desktop.
LLDB is typically used with the Clang compiler (even though you can use it
with GCC, too).
On \macos you can use the LLDB version delivered with Xcode or build from source.
The minimum supported version is LLDB 320.4.
On Linux, the minimum supported version is LLDB 3.8.
\omit
\section2 GDB Adapter Modes
[Advanced Topic]
The GDB native debugger used internally by the debugger plugin runs in
different adapter modes to cope with the variety of supported platforms and
environments. All GDB adapters inherit from AbstractGdbAdapter:
\list
\li PlainGdbAdapter debugs locally started GUI processes. It is
physically split into parts that are relevant only when Python is
available, parts relevant only when Python is not available, and
mixed code.
\li TermGdbAdapter debugs locally started processes that need a console.
\li AttachGdbAdapter debugs local processes started outside \QC.
\li CoreGdbAdapter debugs core files generated from crashes.
\li RemoteGdbAdapter interacts with the GDB server running on Linux.
\endlist
\endomit
\section1 Installing Native Debuggers
The following sections provide information about installing native
debuggers.
\section2 GDB
On Windows, use the Python-enabled GDB version that is bundled
with the Qt package or comes with recent versions of \MinGW. On
most Linux distributions, the GDB builds shipped with the system
are sufficient.
You can also build your own GDB, as instructed in
\l{http://wiki.qt.io/QtCreator_Build_Gdb}{Building GDB}.
Builds of GDB shipped with Xcode on \macos are no longer supported.
\section2 Debugging Tools for Windows
To use the CDB debugger, you must install the
\e{Debugging tools for Windows}. You can download them from
\l{https://developer.microsoft.com/windows/downloads/windows-10-sdk}
{Download and Install Debugging Tools for Windows} as part of the Windows
SDK.
\note Visual Studio does not include the Debugging tools needed,
and therefore, you must install them separately.
In addition, you must select \uicontrol {\QC CDB Debugger Support}
(in \uicontrol Qt > \uicontrol Tools > \uicontrol {\QC}) when you install
Qt or the stand-alone \QC.
When manually building \QC using
the Microsoft Visual C++ Compiler, the build process checks for
the required files in
\c{"%ProgramFiles%\Debugging Tools for Windows"}.
It is highly recommended that you add the Symbol Server provided
by Microsoft to the symbol search path of the debugger. The
Symbol Server provides you with debugging informaton for the
operating system libraries for debugging Windows applications.
For more information, see
\l{Setting CDB Paths on Windows}.
\section2 Debugging Tools for \macos
The Qt binary distribution contains both debug and release
variants of the libraries. But you have to explicitly tell the
runtime linker that you want to use the debug libraries even if
your application is compiled as debug, as release is the default
library.
If you use a qmake based project in \QC, you can set a flag in
your \l{glossary-run-config}{run configuration}, in
\uicontrol Projects mode. In the run configuration, select
\uicontrol{Use debug version of frameworks}.
For more detailed information about debugging on \macos,
see: \l{http://developer.apple.com/library/mac/#technotes/tn2124/_index.html#//apple_ref/doc/uid/DTS10003391}
{Mac OS X Debugging Magic}.
\section2 LLDB
We recommend using the LLDB version that is delivered with the latest Xcode.
\section1 Setting up FSF GDB for \macos
To use FSF GDB on \macos, you must sign it and add it to the \QC
\l{glossary-buildandrun-kit}{kits}.
\list 1
\li To create a key for signing FSF GDB, select
\uicontrol {Keychain Access} > \uicontrol {Certificate Assistant} >
\uicontrol {Create a Certificate}:
\list 1
\li In the \uicontrol Name field, input \uicontrol fsfgdb to
replace the existing content.
\li In the \uicontrol {Certificate Type} field, select
\uicontrol {Code Signing}.
\li Select the \uicontrol {Let me override defaults} check box.
\li Select \uicontrol Continue, and follow the instructions of the
wizard (use the default settings), until the
\uicontrol {Specify a Location For The Certificate} dialog
opens.
\li In the \uicontrol Keychain field, select \uicontrol System.
\li Select \uicontrol {Keychain Access} > \uicontrol System, and
locate the certificate.
\li Double click the certificate to view certificate information.
\li In the \uicontrol Trust section, select
\uicontrol {Always Trust} in the
\uicontrol {When using this certificate} field, and then close
the dialog.
\endlist
\li To sign the binary, enter the following command in the terminal:
\code
codesign -f -s "fsfgdb" $INSTALL_LOCATION/fsfgdb
\endcode
\li In \QC, select \uicontrol {\QC} > \uicontrol Preferences >
\uicontrol Kits > \uicontrol Add to
create a kit that uses FSF GDB.
\li In the \uicontrol Debugger field, specify the path to FSF GDB
(\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for
\c $HOME).
\li To use the debugger, add the kit in the \uicontrol {Build Settings}
of the project.
\endlist
*/
|
