gdb/doc: extend the documentation for the 'handle' command

Message ID d485111cf21d559d3db32bde4eadb34412a20c50.1675338730.git.aburgess@redhat.com
State Committed
Commit 85df9457b72e4a198b4edfc908017612fca59509
Headers
Series gdb/doc: extend the documentation for the 'handle' command |

Commit Message

Andrew Burgess Feb. 2, 2023, 11:52 a.m. UTC
  The documentation for the 'handle' command does not cover all of the
features of the command, and in one case, is just wrong.

The user can specify 'all' as signal name, the documentation implies
that this will change the behaviour of all signals, in reality, this
changes all signals except SIGINT and SIGTRAP (the signals used by
GDB).  I've updated the docs to list this limitation.

The 'handle' command also allows the user to specify multiple signals
for a single command, e.g. 'handle SIGFPE SIGILL nostop pass print',
however the documentation doesn't describe this, so I've updated the
docs to describe this feature.
---
 gdb/doc/gdb.texinfo | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)


base-commit: cded17bfca35566fa4d36e9ec06fa071bd7dab17
  

Comments

Eli Zaretskii Feb. 2, 2023, 2:19 p.m. UTC | #1
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Thu,  2 Feb 2023 11:52:25 +0000
> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
> 
> The documentation for the 'handle' command does not cover all of the
> features of the command, and in one case, is just wrong.
> 
> The user can specify 'all' as signal name, the documentation implies
> that this will change the behaviour of all signals, in reality, this
> changes all signals except SIGINT and SIGTRAP (the signals used by
> GDB).  I've updated the docs to list this limitation.
> 
> The 'handle' command also allows the user to specify multiple signals
> for a single command, e.g. 'handle SIGFPE SIGILL nostop pass print',
> however the documentation doesn't describe this, so I've updated the
> docs to describe this feature.
> ---
>  gdb/doc/gdb.texinfo | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)

Thanks, this is okay.
  
Andrew Burgess Feb. 6, 2023, 2:57 p.m. UTC | #2
Eli Zaretskii <eliz@gnu.org> writes:

>> Cc: Andrew Burgess <aburgess@redhat.com>
>> Date: Thu,  2 Feb 2023 11:52:25 +0000
>> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
>> 
>> The documentation for the 'handle' command does not cover all of the
>> features of the command, and in one case, is just wrong.
>> 
>> The user can specify 'all' as signal name, the documentation implies
>> that this will change the behaviour of all signals, in reality, this
>> changes all signals except SIGINT and SIGTRAP (the signals used by
>> GDB).  I've updated the docs to list this limitation.
>> 
>> The 'handle' command also allows the user to specify multiple signals
>> for a single command, e.g. 'handle SIGFPE SIGILL nostop pass print',
>> however the documentation doesn't describe this, so I've updated the
>> docs to describe this feature.
>> ---
>>  gdb/doc/gdb.texinfo | 15 ++++++++-------
>>  1 file changed, 8 insertions(+), 7 deletions(-)
>
> Thanks, this is okay.

Thanks, pushed.

Andrew
  

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 03033c7f9e3..30b699f3d31 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -6760,13 +6760,14 @@ 
 for details about this command.
 
 @kindex handle
-@item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]}
-Change the way @value{GDBN} handles signal @var{signal}.  The @var{signal}
-can be the number of a signal or its name (with or without the
-@samp{SIG} at the beginning); a list of signal numbers of the form
-@samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the
-known signals.  Optional arguments @var{keywords}, described below,
-say what change to make.
+@item handle @var{signal} @r{[} @var{signal} @dots{} @r{]} @r{[}@var{keywords}@dots{}@r{]}
+Change the way @value{GDBN} handles each @var{signal}.  Each
+@var{signal} can be the number of a signal or its name (with or
+without the @samp{SIG} at the beginning); a list of signal numbers of
+the form @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning
+all the known signals, except @code{SIGINT} and @code{SIGTRAP}, which
+are used by @value{GDBN}.  Optional argument @var{keywords}, described
+below, say what changes to make to all of the specified signals.
 @end table
 
 @c @group