Update documentation for Python Frame.older and Frame.newer
authorTom Tromey <tromey@adacore.com>
Fri, 19 May 2023 15:40:35 +0000 (09:40 -0600)
committerTom Tromey <tromey@adacore.com>
Fri, 19 May 2023 16:47:09 +0000 (10:47 -0600)
I noticed that Frame.older and Frame.newer don't document that they
return None at the ends of the stack.  This patch updates the
documentation, and also fixes a somewhat related typo in a comment
that I noticed while digging into this.

Approved-By: Eli Zaretskii <eliz@gnu.org>
gdb/doc/python.texi
gdb/frame.c

index d93ee55690ee7491acc0deeb719fc92b5937336b..c93f289746cadeaaabb5986b0d7e62d0033e89e8 100644 (file)
@@ -5367,11 +5367,13 @@ Return the symbol for the function corresponding to this frame.
 @end defun
 
 @defun Frame.older ()
-Return the frame that called this frame.
+Return the frame that called this frame.  If this is the oldest frame,
+return @code{None}.
 @end defun
 
 @defun Frame.newer ()
-Return the frame called by this frame.
+Return the frame called by this frame.  If this is the newest frame,
+return @code{None}.
 @end defun
 
 @defun Frame.find_sal ()
index c8b8d2e257e336e4d28feb1ecf94d33b301bd1a5..57d53410cc0aae0ace873bdf1ffcdc5862bb77a5 100644 (file)
@@ -2601,7 +2601,7 @@ inside_entry_func (frame_info_ptr this_frame)
 }
 
 /* Return a structure containing various interesting information about
-   the frame that called THIS_FRAME.  Returns NULL if there is entier
+   the frame that called THIS_FRAME.  Returns NULL if there is either
    no such frame or the frame fails any of a set of target-independent
    condition that should terminate the frame chain (e.g., as unwinding
    past main()).