Doc: Describe Debugging Helper Customization field

We have several user questions and bug reports about
SIGSTOP preventing users from debugging, so use SIGSTOP
signal handling as an example.

Task-number: QTCREATORBUG-24500
Change-Id: I2243d45ef4f5354a15712567882861053d3d6a7a
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Leena Miettinen
2021-01-25 13:12:32 +01:00
parent d3b5e373b8
commit 460f1d3ecd
2 changed files with 26 additions and 4 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2020 The Qt Company Ltd. ** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -843,6 +843,31 @@
Linux, LLDB on macOS, and CDB on Windows, or any other platform on which at Linux, LLDB on macOS, and CDB on Windows, or any other platform on which at
least one of the three supported backends is available. least one of the three supported backends is available.
\section2 Customizing Built-In Debugging Helpers
You can have commands executed after built-in debugging helpers have
been loaded and fully initialized. To load additional debugging helpers or
modify existing ones, select \uicontrol Tools > \uicontrol Options >
\uicontrol Debugger > \uicontrol {Locals & Expressions}, and enter the
commands in the \uicontrol {Debugging Helper Customization} field.
\image qtcreator-debugging-helper-options.png
If you receive error messages about receiving signals when using GDB, you
can specify \l{https://sourceware.org/gdb/onlinedocs/gdb/Signals.html}
{GDB commands} for handling the signals. For example, you can tell GDB to
ignore the \c SIGSTOP signal if you receive the following error message:
\c {The inferior stopped because it received a signal from the operating
system. Signal name: SIGSTOP}.
To stop GDB from handling the \c SIGSTOP signal, add the following commands
to the \uicontrol {Debugging Helper Customization} field:
\badcode
handle SIGSTOP nopass
handle SIGSTOP nostop
\endcode
\section2 Adding Custom Debugging Helpers \section2 Adding Custom Debugging Helpers
To add debugging helpers for your own types, no compilation is required, To add debugging helpers for your own types, no compilation is required,
@@ -889,9 +914,6 @@
\uicontrol Tools > \uicontrol Options > \uicontrol Debugger > \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
\uicontrol {Locals & Expressions} > \uicontrol {Locals & Expressions} >
\uicontrol {Extra Debugging Helpers}. \uicontrol {Extra Debugging Helpers}.
\image qtcreator-debugging-helper-options.png
\endlist \endlist
The custom debugging helpers will be automatically picked up from The custom debugging helpers will be automatically picked up from