aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Tromey <tromey@adacore.com>2023-05-19 09:40:35 -0600
committerTom Tromey <tromey@adacore.com>2023-05-19 10:47:09 -0600
commit3f33695b64123e60a7487eb1a9f91a40a42f0f9f (patch)
tree1ecc7f083511428e092489b4f4f7b92dee4594dc
parent05d31a0b3f03d391a067df8808aafdf302a49bcf (diff)
downloadgdb-3f33695b64123e60a7487eb1a9f91a40a42f0f9f.zip
gdb-3f33695b64123e60a7487eb1a9f91a40a42f0f9f.tar.gz
gdb-3f33695b64123e60a7487eb1a9f91a40a42f0f9f.tar.bz2
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 <eliz@gnu.org>
-rw-r--r--gdb/doc/python.texi6
-rw-r--r--gdb/frame.c2
2 files changed, 5 insertions, 3 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index d93ee55..c93f289 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 c8b8d2e..57d5341 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()).