From: Tom Tromey <tom@tromey.com>
Date: Sat, 19 Feb 2022 16:33:12 +0000 (-0700)
Subject: Add to documentation of Python 'dont_repeat' method
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=285dfa0f6877ea7677e84c3c1001c5d339fbbe5e;p=binutils-gdb.git

Add to documentation of Python 'dont_repeat' method

PR python/28533 points out that the Python 'dont_repeat' documentation
is a bit ambiguous about when the method ought to be called.  This
patch spells it out.
---

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 75804ef975e..62db5f27016 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4001,8 +4001,10 @@ not documented.'' is used.
 @defun Command.dont_repeat ()
 By default, a @value{GDBN} command is repeated when the user enters a
 blank line at the command prompt.  A command can suppress this
-behavior by invoking the @code{dont_repeat} method.  This is similar
-to the user command @code{dont-repeat}, see @ref{Define, dont-repeat}.
+behavior by invoking the @code{dont_repeat} method at some point in
+its @code{invoke} method (normally this is done early in case of
+exception).  This is similar to the user command @code{dont-repeat},
+see @ref{Define, dont-repeat}.
 @end defun
 
 @defun Command.invoke (argument, from_tty)