From 3f33695b64123e60a7487eb1a9f91a40a42f0f9f Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Fri, 19 May 2023 09:40:35 -0600 Subject: [PATCH] Update documentation for Python Frame.older and Frame.newer 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 --- gdb/doc/python.texi | 6 ++++-- gdb/frame.c | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index d93ee55690e..c93f289746c 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -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 () diff --git a/gdb/frame.c b/gdb/frame.c index c8b8d2e257e..57d53410cc0 100644 --- a/gdb/frame.c +++ b/gdb/frame.c @@ -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()). -- 2.30.2