feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Reformat

Browse Source 
No text change

Change-Id: I757d1c07a37df917fa96d6099b9f3dea8426e378
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
This commit is contained in:
Tobias Hunger
2015-06-18 13:07:12 +02:00
parent 08cf5f5b36
commit e83222d928
1 changed files with 66 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
doc/src/debugger/creator-debugger-setup.qdoc
View File

@@ -32,53 +32,50 @@
\title Setting Up Debugger \title Setting Up Debugger
The main debugger settings are associated with the The main debugger settings are associated with the
\l{glossary-buildandrun-kit}{kit} you build and run your project with. To specify the \l{glossary-buildandrun-kit}{kit} you build and run your project with. To
debugger and compiler to use for each kit, select \uicontrol Tools > specify the debugger and compiler to use for each kit, select
\uicontrol Options > \uicontrol {Build and Run} > \uicontrol Kits. \uicontrol Tools > \uicontrol Options > \uicontrol {Build and Run} >
\uicontrol Kits.
You need to set up the debugger only if the automatic setup You need to set up the debugger only if the automatic setup fails, because
fails, because the native debugger is missing (as is usually the the native debugger is missing (as is usually the case for the CDB debugger
case for the CDB debugger on Windows, which you always must install on Windows, which you always must install yourself) or because the installed
yourself) or because the installed version is not supported (for example, version is not supported (for example, when your system contains no, or an
when your system contains no, or an outdated version of GDB and you outdated version of GDB and you want to use a locally installed replacement
want to use a locally installed replacement instead). instead).
\note If you need to change the debugger to use for an automatically \note If you need to change the debugger to use for an automatically
detected \l{glossary-buildandrun-kit}{kit}, detected \l{glossary-buildandrun-kit}{kit}, you can \uicontrol{Clone} the
you can \uicontrol{Clone} the kit and change the parameters in kit and change the parameters in the clone. Make sure to select the cloned
the clone. Make sure to select the cloned kit for your project. kit for your project.
If the debugger you want to use is not automatically detected, select If the debugger you want to use is not automatically detected, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\uicontrol Debuggers > \uicontrol Add \uicontrol Debuggers > \uicontrol Add to add it.
to add it.
\note To use the debugging tools for Windows, you must install them \note To use the debugging tools for Windows, you must install them and add
and add the Symbol Server provided by Microsoft to the symbol search the Symbol Server provided by Microsoft to the symbol search path of the
path of the debugger. For more information, see \l{Setting the Symbol debugger. For more information, see \l{Setting the Symbol Server in
Server in Windows}. Windows}.
\note To use the Free Software Foundation (FSF) version of GDB on \note To use the Free Software Foundation (FSF) version of GDB on OS X, you
OS X, you must sign it and modify your \l{glossary-buildandrun-kit}{kit} must sign it and modify your \l{glossary-buildandrun-kit}{kit} settings.
settings.
This section explains the options you have for debugging C++ code This section explains the options you have for debugging C++ code and
and provides installation notes for the supported native debuggers. provides installation notes for the supported native debuggers. It also
It also applies for code in other compiled languages such as C, applies for code in other compiled languages such as C, FORTRAN, Ada.
FORTRAN, Ada.
For more information on the debugger modes, see For more information on the debugger modes, see
\l{Launching the Debugger in Different Modes}. \l{Launching the Debugger in Different Modes}.
\section1 Supported Native Debugger Versions \section1 Supported Native Debugger Versions
Qt Creator supports native debuggers when working with Qt Creator supports native debuggers when working with compiled code. On
compiled code. On most supported platforms, the GNU Symbolic Debugger most supported platforms, the GNU Symbolic Debugger GDB can be used. On
GDB can be used. On Microsoft Windows, when using the Microsoft tool chain Microsoft Windows, when using the Microsoft tool chain the Microsoft Console
the Microsoft Console Debugger CDB, is needed. On OS X, the LLDB Debugger CDB, is needed. On OS X, the LLDB debugger can be used. Basic
debugger can be used. Basic support for LLDB is also available on Linux, support for LLDB is also available on Linux, but it is restricted by LLDB's
but it is restricted by LLDB's capabilities there, and considered capabilities there, and considered experimental.
experimental.
The following table summarizes the support for debugging C++ code: The following table summarizes the support for debugging C++ code:
@@ -111,25 +108,25 @@
\section2 Supported GDB Versions \section2 Supported GDB Versions
Starting with version 3.1, \QC requires the Python scripting Starting with version 3.1, \QC requires the Python scripting extension. GDB
extension. GDB builds without Python scripting are not supported builds without Python scripting are not supported anymore and will not work.
anymore and will not work. The minimal supported version is GDB 7.5 The minimal supported version is GDB 7.5 using Python version 2.7, or 3.3,
using Python version 2.7, or 3.3, or newer. or newer.
For remote debugging using GDB and GDB server, the minimal For remote debugging using GDB and GDB server, the minimal supported version
supported version of GDB server on the target device is 7.0. of GDB server on the target device is 7.0.
\section2 Supported CDB Versions \section2 Supported CDB Versions
All versions of CDB targeting platforms supported by Qt All versions of CDB targeting platforms supported by Qt are supported by
are supported by \QC. \QC.
\section2 Supported LLDB Versions \section2 Supported LLDB Versions
The LLDB native debugger has similar functionality to the GDB debugger. The LLDB native debugger has similar functionality to the GDB debugger. LLDB
LLDB is the default debugger in Xcode on OS X for supporting C++ on the is the default debugger in Xcode on OS X for supporting C++ on the desktop.
desktop. LLDB is typically used with the Clang compiler (even though you LLDB is typically used with the Clang compiler (even though you can use it
can use it with GCC, too). with GCC, too).
You can use the LLDB version delivered with Xcode, but we recommend that you You can use the LLDB version delivered with Xcode, but we recommend that you
build it from sources using Xcode. The minimal supported version is LLDB build it from sources using Xcode. The minimal supported version is LLDB
@@ -152,8 +149,7 @@
available, parts relevant only when Python is not available, and available, parts relevant only when Python is not available, and
mixed code. mixed code.
\li TermGdbAdapter debugs locally started processes that need a \li TermGdbAdapter debugs locally started processes that need a console.
console.
\li AttachGdbAdapter debugs local processes started outside \QC. \li AttachGdbAdapter debugs local processes started outside \QC.
@@ -176,15 +172,13 @@
\li Notes \li Notes
\row \row
\li GDB \li GDB
\li On Windows, use the Python-enabled GDB versions that \li On Windows, use the Python-enabled GDB versions that is bundled
is bundled with the Qt package or comes with recent with the Qt package or comes with recent versions of MinGW. On
versions of MinGW. On most Linux distributions the GDB most Linux distributions the GDB builds shipped with the system
builds shipped with the system are sufficient. You can are sufficient. You can also build your own. Follow the
also build your own. Follow the instructions in instructions in \l{http://wiki.qt.io/QtCreator_Build_Gdb}
\l{http://wiki.qt.io/QtCreator_Build_Gdb} {Building GDB}. Builds of GDB shipped with Xcode on OS X are no
{Building GDB}. longer supported.
Builds of GDB shipped with Xcode on OS X are no longer
supported.
\row \row
\li Debugging tools for Windows \li Debugging tools for Windows
@@ -217,8 +211,8 @@
your application is compiled as debug, as release is the default your application is compiled as debug, as release is the default
library. library.
If you use a qmake based project in \QC, you can set a If you use a qmake based project in \QC, you can set a flag in
flag in your \l{glossary-run-config}{run configuration}, in your \l{glossary-run-config}{run configuration}, in
\uicontrol Projects mode. In the run configuration, select \uicontrol Projects mode. In the run configuration, select
\uicontrol{Use debug version of frameworks}. \uicontrol{Use debug version of frameworks}.
@@ -239,22 +233,22 @@
\list 1 \list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
> \uicontrol General > \uicontrol Add. \uicontrol General > \uicontrol Add.
\li In the \uicontrol {Source path} field, specify the source path in the \li In the \uicontrol {Source path} field, specify the source path in
debug information of the executable as reported by the debugger. the debug information of the executable as reported by the debugger.
\li In the \uicontrol {Target path} field, specify the actual location of the \li In the \uicontrol {Target path} field, specify the actual location
source tree on the local machine. of the source tree on the local machine.
\endlist \endlist
\section1 Setting the Symbol Server in Windows \section1 Setting the Symbol Server in Windows
To obtain debugging information for the operating system libraries for To obtain debugging information for the operating system libraries for
debugging Windows applications, add the Symbol Server provided debugging Windows applications, add the Symbol Server provided by Microsoft
by Microsoft to the symbol search path of the debugger: to the symbol search path of the debugger:
\list 1 \list 1
@@ -290,8 +284,8 @@
\list 1 \list 1
\li In the \uicontrol {Name} field, input \uicontrol {fsfgdb} to replace \li In the \uicontrol {Name} field, input \uicontrol {fsfgdb} to
the existing content. replace the existing content.
\li In the \uicontrol {Certificate Type} field, select \li In the \uicontrol {Certificate Type} field, select
\uicontrol {Code Signing}. \uicontrol {Code Signing}.
@@ -299,8 +293,9 @@
\li Select the \uicontrol {Let me override defaults} check box. \li Select the \uicontrol {Let me override defaults} check box.
\li Select \uicontrol Continue, and follow the instructions of the \li Select \uicontrol Continue, and follow the instructions of the
wizard (use the default settings), until the \uicontrol {Specify a wizard (use the default settings), until the
Location For The Certificate} dialog opens. \uicontrol {Specify a Location For The Certificate} dialog
opens.
\li In the \uicontrol Keychain field, select \uicontrol System. \li In the \uicontrol Keychain field, select \uicontrol System.
@@ -309,7 +304,8 @@
\li Double click the certificate to view certificate information. \li Double click the certificate to view certificate information.
\li In the \uicontrol Trust section, select \uicontrol {Always Trust} in the \li In the \uicontrol Trust section, select
\uicontrol {Always Trust} in the
\uicontrol {When using this certificate} field, and then close \uicontrol {When using this certificate} field, and then close
the dialog. the dialog.