summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2023-03-22 17:11:07 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2023-03-24 07:24:26 +0000
commit31ea42eb541e4facdbe771eb101b893c089b206b (patch)
tree03fe5e98138f9831ed9bee8ce2d29e382f3848f2 /doc
parent7babb9677db9ebb00a3bd8c1f13c0d9f8edb1080 (diff)
downloadqt-creator-31ea42eb541e4facdbe771eb101b893c089b206b.tar.gz
Doc: Describe Threads, Modules, and Source Files debugger views
Add screenshots and more information about the views. Task-number: QTCREATORBUG-28778 Change-Id: I385c1f6dd5eeed20d122bed2d9420b32b9a3d70b Reviewed-by: David Schulz <david.schulz@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/qtcreator/images/qtcreator-debugger-modules.webpbin0 -> 7760 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-debugger-source-files.webpbin0 -> 2226 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-debugger-threads.webpbin0 -> 4800 bytes
-rw-r--r--doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc96
4 files changed, 73 insertions, 23 deletions
diff --git a/doc/qtcreator/images/qtcreator-debugger-modules.webp b/doc/qtcreator/images/qtcreator-debugger-modules.webp
new file mode 100644
index 0000000000..e4af9e817d
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-debugger-modules.webp
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-debugger-source-files.webp b/doc/qtcreator/images/qtcreator-debugger-source-files.webp
new file mode 100644
index 0000000000..7f8faabd4f
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-debugger-source-files.webp
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-debugger-threads.webp b/doc/qtcreator/images/qtcreator-debugger-threads.webp
new file mode 100644
index 0000000000..1a84d6ae2b
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-debugger-threads.webp
Binary files differ
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
index 961b2d2e74..1009f765ab 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
@@ -879,10 +879,24 @@
\title Viewing Threads
- If a multi-threaded application is interrupted, the \uicontrol Threads view or
- the combobox named \uicontrol Threads in the debugger status bar can be used
- to switch from one thread to another. The \uicontrol Stack view adjusts
- itself accordingly.
+ An application can have more than one thread of execution that share one
+ address space, which means that they can examine and change the same
+ variables. However, each thread has its own registers, execution stack,
+ and possibly private memory.
+
+ When a multi-threaded application is interrupted, you can view the threads
+ currently active in the application and switch between them in the
+ \uicontrol Threads view (1):
+
+ \image qtcreator-debugger-threads.webp {Threads view}
+
+ You can also select a thread in the \uicontrol Threads field (2) on the
+ debugger toolbar.
+
+ This allows you to select the thread that is in the focus of the debugger.
+
+ The \l {Viewing Call Stack Trace}{Stack} view adjusts its contents
+ accordingly.
*/
/*!
@@ -893,38 +907,59 @@
\title Viewing Modules
The \uicontrol Modules view displays information that the debugger plugin
- has about modules included in the application that is being debugged. A
- module is a dynamic link library (\c {.dll}) in Windows, a shared object
- (\c {.so}) in Linux, and a dynamic shared library (\c {.dylib}) in \macos.
+ has about modules included in the application that is being debugged.
+
+ A module is:
+
+ \list
+ \li A dynamic link library (\c {.dll}) in Windows
+ \li A shared object (\c {.so}) in Linux
+ \li A dynamic shared library (\c {.dylib}) in \macos
+ \endlist
+
+ \image qtcreator-debugger-modules.webp {Modules view}
In addition, the view displays symbols within the modules and indicates
- where each module was loaded.
+ where each module was loaded. Right-click column headers to show and
+ hide columns in the view.
- Right-click the view to open a context menu that has menu items for:
+ Right-click the view to select the following actions:
\list
- \li Updating the module list
+ \li Update the module list
+
+ \li Show source files for a module
+
+ \li Show dependencies between modules (Windows only)
- \li Loading symbols for modules
+ \li Load symbols for modules
- \li Examining modules
+ \li Examine modules
- \li Editing module files
+ \li Edit module files
- \li Showing symbols in modules
+ \li Show symbols in modules
- \li Showing dependencies between modules (Windows only)
+ \li Show sections in modules
+
+ \li Set \l{Debugger Preferences}{debugger preferences}
\endlist
- By default, the \uicontrol Modules view is hidden.
+ By default, the \uicontrol Modules view is hidden. To show it, select it in
+ \uicontrol Views on the debugger toolbar.
+
+ \section1 Breaking on Loading Modules in CDB
When using CDB as debug backend, you can specify that the debugger should
break when application modules are loaded or unloaded. To enable breaking
for the specified modules, select \uicontrol Edit > \uicontrol Preferences >
- \uicontrol Debugger > \uicontrol CDB. For more information, see
- \l{Specifying CDB Settings}.
+ \uicontrol Debugger > \uicontrol CDB.
+
+ \image qtcreator-cdb-options.png {CDB tab in Debugger preferences}
+
+ For more information, see \l{Specifying CDB Settings}.
*/
/*!
@@ -939,15 +974,30 @@
the source file is actually part of the project, or whether it was compiled
elsewhere. The view shows the path to each file in the file system.
- Right-click the view to open a context menu that has menu items for
- reloading data and opening files.
+ \image qtcreator-debugger-source-files.webp {Source Files view}
+
+ Right-click the view to select the following actions:
+
+ \list
+ \li Reload data
+ \li Open the selected file
+ \li Set \l{Debugger Preferences}{debugger preferences}
+ \endlist
+
+ By default, the \uicontrol {Source Files} view is hidden. To show it, select
+ it in \uicontrol Views on the debugger toolbar.
+
+ \section1 External Sources
To enable the debugger to step into the code and display the source code
when using a copy of the source tree at a location different from the one
at which the libraries were built, you can map source paths to target
- paths. For more information, see \l{Mapping Source Paths}.
+ paths in \uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger >
+ \uicontrol General:
+
+ \image qtcreator-debugger-general-options.png {General tab in Debugger preferences}
- By default, the \uicontrol {Source Files} view is hidden.
+ For more information, see \l{Mapping Source Paths}.
*/
/*!
@@ -1009,7 +1059,7 @@
\uicontrol Debug > \uicontrol {Operate by Instruction} while the debugger is
running. Alternatively, click the
\inlineimage icons/debugger_singleinstructionmode.png
- (\uicontrol {Operate by Instruction}) tool button on the debugger tool bar.
+ (\uicontrol {Operate by Instruction}) tool button on the debugger toolbar.
By default, GDB shows AT&T style disassembly. To switch to the Intel style,
select \uicontrol Edit > \uicontrol Preferences > \uicontrol Debugger >