forked from qt-creator/qt-creator
Doc: Omit "native" when discussing debuggers
Also avoid talking about "debugger plugin". Change-Id: Iba60f8ad9c655812b6a48e38c1523ddce4f8dcb6 Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
@@ -14,11 +14,11 @@
|
|||||||
|
|
||||||
\ingroup creator-reference-debugger
|
\ingroup creator-reference-debugger
|
||||||
|
|
||||||
\title Supported Native Debuggers
|
\title Supported Debuggers
|
||||||
|
|
||||||
\brief Summary of supported debugger versions.
|
\brief Summary of supported debugger versions.
|
||||||
|
|
||||||
\QC supports native debuggers for debugging compiled code.
|
You can use \QC to debug compiled code.
|
||||||
On most supported platforms, you can use the GNU Symbolic Debugger (GDB).
|
On most supported platforms, you can use the GNU Symbolic Debugger (GDB).
|
||||||
On Microsoft Windows, when using the Microsoft toolchain, you need the
|
On Microsoft Windows, when using the Microsoft toolchain, you need the
|
||||||
Microsoft Console Debugger (CDB). On \macos and Linux, you can use the LLDB
|
Microsoft Console Debugger (CDB). On \macos and Linux, you can use the LLDB
|
||||||
@@ -34,7 +34,7 @@
|
|||||||
\header
|
\header
|
||||||
\li Platform
|
\li Platform
|
||||||
\li Compiler
|
\li Compiler
|
||||||
\li Native Debugger
|
\li Debugger
|
||||||
\row
|
\row
|
||||||
\li Linux
|
\li Linux
|
||||||
\li GCC, ICC
|
\li GCC, ICC
|
||||||
@@ -57,9 +57,9 @@
|
|||||||
\li Debugging Tools for Windows/CDB
|
\li Debugging Tools for Windows/CDB
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
The debugger plugin automatically selects a suitable native debugger for
|
\QC automatically selects a suitable debugger for
|
||||||
each \l{Kits}{kit} from the ones found on the computer. The automatic
|
each \l{Kits}{kit} from the ones found on the computer. The automatic
|
||||||
setup fails if the native debugger is not installed on the computer or
|
setup fails if the debugger is not installed on the computer or
|
||||||
if \QC does not support the installed version.
|
if \QC does not support the installed version.
|
||||||
|
|
||||||
\section1 GDB Versions
|
\section1 GDB Versions
|
||||||
@@ -123,7 +123,7 @@
|
|||||||
{Mac OS X Debugging Magic}.
|
{Mac OS X Debugging Magic}.
|
||||||
\section1 LLDB Versions
|
\section1 LLDB Versions
|
||||||
|
|
||||||
The LLDB native debugger has similar functionality to the GDB debugger. LLDB
|
The LLDB debugger has similar functionality to the GDB debugger. LLDB
|
||||||
is the default debugger in Xcode on \macos for C++ on the desktop.
|
is the default debugger in Xcode on \macos for C++ on the desktop.
|
||||||
LLDB is typically used with the Clang compiler (even though you can use it
|
LLDB is typically used with the Clang compiler (even though you can use it
|
||||||
with GCC, too).
|
with GCC, too).
|
||||||
|
@@ -14,8 +14,7 @@
|
|||||||
|
|
||||||
\title Debugging
|
\title Debugging
|
||||||
|
|
||||||
The \QC debugger plugin acts as an interface between the \QC
|
You can use debuggers to:
|
||||||
core and external native debuggers that you can use to:
|
|
||||||
|
|
||||||
\list
|
\list
|
||||||
\li Debug executable binary files - GNU Symbolic Debugger (GDB),
|
\li Debug executable binary files - GNU Symbolic Debugger (GDB),
|
||||||
@@ -28,7 +27,7 @@
|
|||||||
|
|
||||||
\section1 Setting Up the Debugger
|
\section1 Setting Up the Debugger
|
||||||
|
|
||||||
The debugger plugin automatically selects a suitable native debugger for
|
\QC automatically selects a suitable debugger for
|
||||||
each \l{Kits}{kit} from the ones found on your system. You can select
|
each \l{Kits}{kit} from the ones found on your system. You can select
|
||||||
another kit. To specify the debugger and compiler to use for each kit, go to
|
another kit. To specify the debugger and compiler to use for each kit, go to
|
||||||
\preferences > \uicontrol Kits.
|
\preferences > \uicontrol Kits.
|
||||||
@@ -36,7 +35,7 @@
|
|||||||
\image qtcreator-kits.png {Kits preferences}
|
\image qtcreator-kits.png {Kits preferences}
|
||||||
|
|
||||||
You need to set up the debugger only if the automatic setup fails because
|
You need to set up the debugger only if the automatic setup fails because
|
||||||
the native debugger is missing (for example, you must install the CDB
|
the debugger is missing (for example, you must install the CDB
|
||||||
debugger on Windows yourself) or because \QC does not support the installed
|
debugger on Windows yourself) or because \QC does not support the installed
|
||||||
version. For example, when your system does not have GDB
|
version. For example, when your system does not have GDB
|
||||||
installed or the installed version is outdated, and you want to use a locally
|
installed or the installed version is outdated, and you want to use a locally
|
||||||
@@ -58,11 +57,11 @@
|
|||||||
Optionally, you can set up the Microsoft Symbol Server if you need
|
Optionally, you can set up the Microsoft Symbol Server if you need
|
||||||
symbol information from Microsoft modules that is not found locally.
|
symbol information from Microsoft modules that is not found locally.
|
||||||
|
|
||||||
For more information, see \l{Supported Native Debuggers} and \l{CDB Paths}.
|
For more information, see \l{Supported Debuggers} and \l{CDB Paths}.
|
||||||
|
|
||||||
\section1 Launching the Debugger
|
\section1 Launching the Debugger
|
||||||
|
|
||||||
The debugger plugin can run the native debuggers in various operating modes
|
The debuggers run in various operating modes
|
||||||
depending on where and how you start and run the debugged process. Some of
|
depending on where and how you start and run the debugged process. Some of
|
||||||
the modes are only available for a particular operating system or platform:
|
the modes are only available for a particular operating system or platform:
|
||||||
|
|
||||||
@@ -93,9 +92,8 @@
|
|||||||
|
|
||||||
\section2 GDB Run Modes
|
\section2 GDB Run Modes
|
||||||
|
|
||||||
The GDB native debugger used internally by the debugger plugin runs in
|
The GDB debugger runs in different modes to cope with the variety of
|
||||||
different modes to cope with the variety of supported platforms and
|
supported platforms and environments:
|
||||||
environments:
|
|
||||||
|
|
||||||
\list
|
\list
|
||||||
\li \e{Plain mode} debugs locally started processes that do not need
|
\li \e{Plain mode} debugs locally started processes that do not need
|
||||||
@@ -770,7 +768,7 @@
|
|||||||
|
|
||||||
The log view acts as a console, so you can send the contents
|
The log view acts as a console, so you can send the contents
|
||||||
of the line under the text cursor in the log directly to the
|
of the line under the text cursor in the log directly to the
|
||||||
native debugger.
|
debugger.
|
||||||
\li \l{Troubleshooting Debugger}
|
\li \l{Troubleshooting Debugger}
|
||||||
|
|
||||||
\l {Debugger Log}
|
\l {Debugger Log}
|
||||||
@@ -865,9 +863,9 @@
|
|||||||
|
|
||||||
\title Examine complex values in Debug views
|
\title Examine complex values in Debug views
|
||||||
|
|
||||||
\QC displays the raw information from the native debuggers in a clear and
|
\QC displays the raw information from the debuggers in a clear and
|
||||||
concise manner to simplify the debugging process without losing the power
|
concise manner to simplify the debugging process without losing the power
|
||||||
of the native debuggers.
|
of the debuggers.
|
||||||
|
|
||||||
\image qtcreator-locals.png {Locals view}
|
\image qtcreator-locals.png {Locals view}
|
||||||
|
|
||||||
@@ -1150,8 +1148,8 @@
|
|||||||
|
|
||||||
\brief View information about the modules included in a debugged application.
|
\brief View information about the modules included in a debugged application.
|
||||||
|
|
||||||
The \uicontrol Modules view displays information that the debugger plugin
|
The \uicontrol Modules view displays information about modules included in
|
||||||
has about modules included in the application that is being debugged.
|
the application that is being debugged.
|
||||||
|
|
||||||
A module is:
|
A module is:
|
||||||
|
|
||||||
@@ -1389,13 +1387,13 @@
|
|||||||
\li Set \l{Debugger}{debugger preferences}.
|
\li Set \l{Debugger}{debugger preferences}.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
\section1 Directly Interacting with Native Debuggers
|
\section1 Directly Interacting with Debuggers
|
||||||
|
|
||||||
You can use the left pane of the \uicontrol {Debugger Log} view to directly
|
You can use the left pane of the \uicontrol {Debugger Log} view to directly
|
||||||
interact with the command line of the native debugger.
|
interact with the command line of the debugger.
|
||||||
|
|
||||||
Press \key {Ctrl+Enter} to send the contents of the line under the
|
Press \key {Ctrl+Enter} to send the contents of the line under the
|
||||||
text cursor to the native debugger. Or, enter the command in the
|
text cursor to the debugger. Or, enter the command in the
|
||||||
\uicontrol Command field. The right side pane of the
|
\uicontrol Command field. The right side pane of the
|
||||||
\uicontrol {Debugger Log} view shows the command output.
|
\uicontrol {Debugger Log} view shows the command output.
|
||||||
|
|
||||||
@@ -1464,7 +1462,7 @@
|
|||||||
\brief Load, customize, and add debugging helpers.
|
\brief Load, customize, and add debugging helpers.
|
||||||
|
|
||||||
\QC uses Python scripts to translate raw memory contents and type information
|
\QC uses Python scripts to translate raw memory contents and type information
|
||||||
data from native debugger backends (GDB, LLDB, and CDB are currently supported)
|
data from debugger backends (GDB, LLDB, and CDB are currently supported)
|
||||||
into the form presented to the user in the
|
into the form presented to the user in the
|
||||||
\l {Local Variables and Function Parameters}{Locals}
|
\l {Local Variables and Function Parameters}{Locals}
|
||||||
and \l {Evaluating Expressions}{Expressions} views.
|
and \l {Evaluating Expressions}{Expressions} views.
|
||||||
@@ -1520,7 +1518,7 @@
|
|||||||
of Qt, or of your own library, at the same time.
|
of Qt, or of your own library, at the same time.
|
||||||
|
|
||||||
To add debugging helpers for custom types, add debugging helper
|
To add debugging helpers for custom types, add debugging helper
|
||||||
implementations to the startup file of the native debuggers (for example,
|
implementations to the startup file of the debuggers (for example,
|
||||||
\c{~/.gdbinit} or \c{~/.lldbinit}) or specify them directly in the
|
\c{~/.gdbinit} or \c{~/.lldbinit}) or specify them directly in the
|
||||||
\uicontrol {Additional Startup Commands} in \preferences >
|
\uicontrol {Additional Startup Commands} in \preferences >
|
||||||
\uicontrol Debugger > \uicontrol GDB.
|
\uicontrol Debugger > \uicontrol GDB.
|
||||||
@@ -1733,7 +1731,7 @@
|
|||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
\li \c{putCallItem(self, name, rettype, value, func, *args)} - Uses the
|
\li \c{putCallItem(self, name, rettype, value, func, *args)} - Uses the
|
||||||
native debugger backend to place the function call \c func returning
|
debugger backend to place the function call \c func returning
|
||||||
\c rettype on the value specified by \a {value} and to output the
|
\c rettype on the value specified by \a {value} and to output the
|
||||||
resulting item.
|
resulting item.
|
||||||
|
|
||||||
@@ -1880,7 +1878,7 @@
|
|||||||
an integral or floating point type.
|
an integral or floating point type.
|
||||||
|
|
||||||
Type objects, that is, instances of the \c{Dumper.Type} class, can be
|
Type objects, that is, instances of the \c{Dumper.Type} class, can be
|
||||||
created by native debugger backends, usually by evaluating Debug Information
|
created by debugger backends, usually by evaluating Debug Information
|
||||||
built into or shipped alongside the debugged binary, or created on-the-fly
|
built into or shipped alongside the debugged binary, or created on-the-fly
|
||||||
by the debugging helper.
|
by the debugging helper.
|
||||||
|
|
||||||
@@ -2110,7 +2108,7 @@
|
|||||||
\l {Run on many platforms}{build and run kit selector}
|
\l {Run on many platforms}{build and run kit selector}
|
||||||
picked a runnable target and you can run the application.
|
picked a runnable target and you can run the application.
|
||||||
|
|
||||||
\li Make sure the debugger is \l{Supported Native Debuggers}{set up properly}.
|
\li Make sure the debugger is \l{Supported Debuggers}{set up properly}.
|
||||||
|
|
||||||
\li In the \uicontrol Debug mode, go to \uicontrol View >
|
\li In the \uicontrol Debug mode, go to \uicontrol View >
|
||||||
\uicontrol Views > \uicontrol {Debugger Log} to open the
|
\uicontrol Views > \uicontrol {Debugger Log} to open the
|
||||||
|
@@ -66,8 +66,7 @@
|
|||||||
|
|
||||||
\section1 Debug
|
\section1 Debug
|
||||||
|
|
||||||
Use native debuggers to inspect the state of your application while
|
Use debuggers to inspect the state of your application while it is running.
|
||||||
debugging.
|
|
||||||
|
|
||||||
\generatelist creator-how-to-debug
|
\generatelist creator-how-to-debug
|
||||||
|
|
||||||
|
@@ -143,7 +143,7 @@
|
|||||||
|
|
||||||
You must use Python version 2.6 or 2.7.
|
You must use Python version 2.6 or 2.7.
|
||||||
|
|
||||||
For more information, see \l{Supported Native Debuggers}.
|
For more information, see \l{Supported Debuggers}.
|
||||||
|
|
||||||
\b {How do I generate a core file in \QC?}
|
\b {How do I generate a core file in \QC?}
|
||||||
|
|
||||||
|
@@ -266,10 +266,10 @@
|
|||||||
to find the next one.
|
to find the next one.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
\QC integrates several native debuggers for inspecting the state of
|
\QC integrates several debuggers for inspecting the state of your
|
||||||
your application while debugging. The debugger plugin automatically selects
|
application. It automatically selects a suitable debugger for each
|
||||||
a suitable native debugger for each kit from the ones it finds on the
|
kit from the ones it finds on the computer. Edit the kits to override
|
||||||
computer. Edit the kits to override this choice.
|
this choice.
|
||||||
|
|
||||||
If you install \QC with \QOI, the GNU Symbolic Debugger is installed
|
If you install \QC with \QOI, the GNU Symbolic Debugger is installed
|
||||||
automatically and you should be ready to start debugging after you create
|
automatically and you should be ready to start debugging after you create
|
||||||
|
@@ -21,7 +21,7 @@
|
|||||||
|
|
||||||
\section1 Debuggers
|
\section1 Debuggers
|
||||||
|
|
||||||
Set up and use native debuggers to debug executable binary files, as well as
|
Set up and use debuggers to debug executable binary files, as well as
|
||||||
QML, Java, and Python source code.
|
QML, Java, and Python source code.
|
||||||
|
|
||||||
\annotatedlist creator-reference-debugger
|
\annotatedlist creator-reference-debugger
|
||||||
|
@@ -15,12 +15,11 @@
|
|||||||
|
|
||||||
\title Add debuggers
|
\title Add debuggers
|
||||||
|
|
||||||
The \QC debugger plugin acts as an interface between the \QC core and
|
You can use debuggers, such as the GNU Symbolic Debugger (GDB),
|
||||||
external native debuggers such as the GNU Symbolic Debugger (GDB),
|
|
||||||
the Microsoft Console Debugger (CDB), a QML/JavaScript debugger, and the
|
the Microsoft Console Debugger (CDB), a QML/JavaScript debugger, and the
|
||||||
debugger of the low level virtual machine (LLVM) project, LLDB.
|
debugger of the low level virtual machine (LLVM) project, LLDB.
|
||||||
|
|
||||||
The debugger plugin automatically selects a suitable native debugger for
|
\QC automatically selects a suitable debugger for
|
||||||
each \l{Kits}{kit} from the ones found on your system.
|
each \l{Kits}{kit} from the ones found on your system.
|
||||||
To override this choice, select \preferences > \uicontrol Kits.
|
To override this choice, select \preferences > \uicontrol Kits.
|
||||||
|
|
||||||
@@ -75,6 +74,6 @@
|
|||||||
The debugger disappears from the list when you select \uicontrol Apply.
|
The debugger disappears from the list when you select \uicontrol Apply.
|
||||||
Until then, you can cancel the deletion by clicking \uicontrol Restore.
|
Until then, you can cancel the deletion by clicking \uicontrol Restore.
|
||||||
|
|
||||||
\sa {Debugging}, {Debuggers}, {Debugger}, {Supported Native Debuggers},
|
\sa {Debugging}, {Debuggers}, {Debugger}, {Supported Debuggers},
|
||||||
{Troubleshooting Debugger}
|
{Troubleshooting Debugger}
|
||||||
*/
|
*/
|
||||||
|
@@ -26,7 +26,7 @@
|
|||||||
\li \l{Run Python applications}
|
\li \l{Run Python applications}
|
||||||
\li \l{Python Run Settings}
|
\li \l{Python Run Settings}
|
||||||
\li \l{PDB versions}
|
\li \l{PDB versions}
|
||||||
\li \l{Supported Native Debuggers}
|
\li \l{Supported Debuggers}
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
For more information about developing with Qt for Python, including
|
For more information about developing with Qt for Python, including
|
||||||
|
Reference in New Issue
Block a user