Doc: Update info about debugging

- Update screenshots
- Fix option names
- Show existing screenshots in more places (where they are
  discussed in text)

Task-number: QTCREATORBUG-27560
Change-Id: I16a45e5e05b8b50932431844e36851f693966201
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Leena Miettinen
2022-07-12 16:19:34 +02:00
parent 7bb5ea287d
commit d6cdce0de5
4 changed files with 28 additions and 9 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

@@ -406,6 +406,15 @@
applications. applications.
\li Select the \uicontrol {Break at "main"} check box to stop the \li Select the \uicontrol {Break at "main"} check box to stop the
debugger at the main function. debugger at the main function.
\li Select the \uicontrol {Use target extended-remote to connect}
check box to create the connection in the
\c {target extended-remote mode}. In this mode, when the debugged
application exits or you detach from it, the debugger remains
connected to the target. You can rerun the application, attach
to a running application, or use monitor commands specific to the
target. For example, GDB does not exit unless it was invoked using
the \c {--once} option, but you can make it exit by using the
\c {monitor exit} command.
\li In the \uicontrol {Override SysRoot} field, specify the path to \li In the \uicontrol {Override SysRoot} field, specify the path to
the \c sysroot to use instead of the default \c sysroot. the \c sysroot to use instead of the default \c sysroot.
\li In the \uicontrol {Init commands} field, enter the commands \li In the \uicontrol {Init commands} field, enter the commands
@@ -430,6 +439,10 @@
to manage the GDB process, see \l{Specifying GDB Settings} and to manage the GDB process, see \l{Specifying GDB Settings} and
\l{Specifying Extended GDB Settings}. \l{Specifying Extended GDB Settings}.
For more informaton about connecting with \c {target extended-remote} mode
in GDB, see \l{https://sourceware.org/gdb/onlinedocs/gdb/Connecting.html}
{Debugging with GDB: Connecting to a Remote Target}.
\section3 Using CDB \section3 Using CDB
In remote mode, the local CDB process talks to a CDB process that runs on In remote mode, the local CDB process talks to a CDB process that runs on
@@ -864,7 +877,7 @@
Debugging helpers are always automatically used. To force a plain C-like Debugging helpers are always automatically used. To force a plain C-like
display of structures, select \uicontrol Edit > \uicontrol Preferences > display of structures, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol Debugger > \uicontrol {Locals & Expressions}, and then deselect \uicontrol Debugger > \uicontrol {Locals & Expressions}, and then deselect
the \uicontrol {Use Debugging Helper} check box. This will still use the the \uicontrol {Use Debugging Helpers} check box. This will still use the
Python scripts, but generate more basic output. To force the plain display Python scripts, but generate more basic output. To force the plain display
for a single object or for all objects of a given type, select the for a single object or for all objects of a given type, select the
corresponding option from the context menu. corresponding option from the context menu.
@@ -893,6 +906,8 @@
\uicontrol Debugger > \uicontrol GDB > \uicontrol {Load system GDB pretty \uicontrol Debugger > \uicontrol GDB > \uicontrol {Load system GDB pretty
printers}. For more information, see \l{Specifying GDB Settings}. printers}. For more information, see \l{Specifying GDB Settings}.
\image qtcreator-gdb-options.png "GDB preferences"
\section2 Customizing Built-In Debugging Helpers \section2 Customizing Built-In Debugging Helpers
You can have commands executed after built-in debugging helpers have You can have commands executed after built-in debugging helpers have
@@ -968,7 +983,7 @@
installation in your file system and specify the location in installation in your file system and specify the location in
\uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger > \uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger >
\uicontrol {Locals & Expressions} > \uicontrol {Locals & Expressions} >
\uicontrol {Extra Debugging Helpers}. \uicontrol {Extra Debugging Helper}.
\endlist \endlist
The custom debugging helpers will be automatically picked up from The custom debugging helpers will be automatically picked up from
@@ -1112,6 +1127,8 @@
selecting \uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger > selecting \uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger >
\uicontrol CDB > \uicontrol {Use Python dumper}. \uicontrol CDB > \uicontrol {Use Python dumper}.
\image qtcreator-cdb-options.png "CDB preferences"
\section3 Dumper Class \section3 Dumper Class
The \c Dumper class contains generic bookkeeping, low-level, and convenience The \c Dumper class contains generic bookkeeping, low-level, and convenience
@@ -1549,6 +1566,8 @@
> \uicontrol Preferences > \uicontrol Debugger > \uicontrol GDB > > \uicontrol Preferences > \uicontrol Debugger > \uicontrol GDB >
\uicontrol {Use automatic symbol cache}. \uicontrol {Use automatic symbol cache}.
\image qtcreator-gdb-options.png "GDB preferences"
Some slowness stems from maintaining breakpoints inside Some slowness stems from maintaining breakpoints inside
the debugger (under some circumstances all breakpoints need to be inserted the debugger (under some circumstances all breakpoints need to be inserted
and removed again for each step) and the evaluation of expressions after and removed again for each step) and the evaluation of expressions after

View File

@@ -195,7 +195,8 @@
If an instance of a class is derived from QObject, and you would like to If an instance of a class is derived from QObject, and you would like to
find all other objects connected to one of your object's slots using find all other objects connected to one of your object's slots using
Qt's signals and slots mechanism, select \uicontrol Edit > \uicontrol Preferences Qt's signals and slots mechanism, select \uicontrol Edit > \uicontrol Preferences
> \uicontrol{Debugger} > \uicontrol{Locals} > \uicontrol{Use Debugging Helper}. > \uicontrol {Debugger} > \uicontrol {Locals & Expressions} >
\uicontrol {Use Debugging Helpers}.
In the \uicontrol{Locals} view, expand the object's entry and open In the \uicontrol{Locals} view, expand the object's entry and open
the slot in the \e slots subitem. The objects connected to this slot are the slot in the \e slots subitem. The objects connected to this slot are
@@ -214,9 +215,9 @@
\list 1 \list 1
\li Select \uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger > \li Select \uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger >
\uicontrol{Locals}. \uicontrol {Locals & Expressions}.
\image qtcreator-debugging-helper-options.png "Locals & Expressions preferences"
\li Uncheck the \uicontrol{Use Debugging Helper} checkbox. \li Deselect \uicontrol {Use Debugging Helpers}.
\endlist \endlist
@@ -229,9 +230,8 @@
\li Select \uicontrol Edit > \uicontrol Preferences > \li Select \uicontrol Edit > \uicontrol Preferences >
\uicontrol Debugger > \uicontrol General. \uicontrol Debugger > \uicontrol General.
\image qtcreator-debugger-general-options.png "Debugger General preferences"
\li Select the \uicontrol {Use tooltips in main editor while debugging} check \li Select \uicontrol {Use tooltips in main editor when debugging}.
box.
\endlist \endlist