diff mbox series

Update Python signal-handling documentation

Message ID 20230911152250.3434008-1-tromey@adacore.com
State New
Headers
Series Update Python signal-handling documentation |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 fail Testing failed
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 fail Patch failed to apply
linaro-tcwg-bot/tcwg_gdb_build--master-arm fail Patch failed to apply
linaro-tcwg-bot/tcwg_gdb_check--master-arm fail Patch failed to apply

Commit Message

Tom Tromey Sept. 11, 2023, 3:22 p.m. UTC 
  I noticed a typo in the "Basic Python" node, and when fixing it
realized that the paragraph could use a link to the block_signals
function.  This patch is the result.
---
 gdb/doc/python.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Eli Zaretskii Sept. 11, 2023, 4:03 p.m. UTC | #1 
> Cc: Tom Tromey <tromey@adacore.com>
> Date: Mon, 11 Sep 2023 09:22:50 -0600
> From: Tom Tromey via Gdb-patches <gdb-patches@sourceware.org>
> 
> I noticed a typo in the "Basic Python" node, and when fixing it
> realized that the paragraph could use a link to the block_signals
> function.  This patch is the result.

Thanks.

> -@code{SIGCHLD} handler.
> +@code{SIGCHLD} handler.  When creating a new Python thread, you can
> +use @code{gdb.block_signals} or @code{gdb.Thread} to handle this
> +correctly; @xref{Threading in GDB}.
              ^^^^^
This should be @pxref or "see @ref"; @xref is only pertinent at the
beginning of a sentence, since it produces a capitalized "See".

OK with that nit fixed.

Approved-By: Eli Zaretskii <eliz@gnu.org>
diff mbox series

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index e9936991c49..af6360ab3f8 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -247,12 +247,14 @@  Some care must be taken when writing Python code to run in
 
 @itemize @bullet
 @item
-@value{GDBN} install handlers for @code{SIGCHLD} and @code{SIGINT}.
+@value{GDBN} installs handlers for @code{SIGCHLD} and @code{SIGINT}.
 Python code must not override these, or even change the options using
 @code{sigaction}.  If your program changes the handling of these
 signals, @value{GDBN} will most likely stop working correctly.  Note
 that it is unfortunately common for GUI toolkits to install a
-@code{SIGCHLD} handler.
+@code{SIGCHLD} handler.  When creating a new Python thread, you can
+use @code{gdb.block_signals} or @code{gdb.Thread} to handle this
+correctly; @xref{Threading in GDB}.
 
 @item
 @value{GDBN} takes care to mark its internal file descriptors as