diff mbox series

Update documentatio for Python Frame.older and Frame.newer

Message ID 20230519154137.3303282-1-tromey@adacore.com
State New
Headers
Series Update documentatio for Python Frame.older and Frame.newer |

Commit Message

Tom Tromey May 19, 2023, 3:41 p.m. UTC 
  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.
---
 gdb/doc/python.texi | 6 ++++--
 gdb/frame.c         | 2 +-
 2 files changed, 5 insertions(+), 3 deletions(-)

Comments

Eli Zaretskii May 19, 2023, 4:09 p.m. UTC | #1 
> Cc: Tom Tromey <tromey@adacore.com>
> Date: Fri, 19 May 2023 09:41:37 -0600
> From: Tom Tromey via Gdb-patches <gdb-patches@sourceware.org>
> 
> 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.
> ---
>  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..4066dafb601 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,
> +@code{None} is returned.
>  @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,
> +@code{None} is returned.
>  @end defun

This is OK, but please use "return @code{None}" instead of
"@code{None} is returned", to avoid passive voice.

Thanks.

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

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index d93ee55690e..4066dafb601 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,
+@code{None} is returned.
 @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,
+@code{None} is returned.
 @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()).