This is the mail archive of the mailing list for the GDB project.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [Patch][Python] PR python/13285 Document named constants for frame unwind stop reasons

On Thu, Oct 13, 2011 at 3:48 PM, Eli Zaretskii <> wrote:
> > From: Kevin Pouget <>
> > Date: Thu, 13 Oct 2011 14:39:16 +0200
> > Cc:,
> >
> > I've prepared a bit of documentation for these named constants, based
> > on their comments in the source code.
> Thanks.
> > +@table @code
> > +No particular reason.
> This begs for some explanation of when this "no-reason" reason will be
> seen. ?Is it true that this value is used when it's NOT impossible to
> find more frames? ?If so, we should say that explicitly.

Yes, that's my understanding too. I've changed the sentence to
> No particular reason (older frames should be available).

I'll commit the patch in an hour, if no one contradicts

> > +@end table
> There's no need to make each value a separate @table. ?You can just
> make them all be a single table, like this:
> ?@table @code
> ?@item foo
> ?Description of foo.
> ?@item bar
> ?Description of bar.
> ?...
> ?@end @table.

sorry, I don't know where I got it from !

2011-10-13  Kevin Pouget  <>

	PR python/13285 Document named constants for frame unwind stop reasons
	* gdb.texinfo (Frames In Python): Document gdb.FRAME_UNWIND_*
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index da04e2e..0aa90eb 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -23414,7 +23414,39 @@ newest frame.
 Return an integer representing the reason why it's not possible to find
 more frames toward the outermost frame.  Use
 @code{gdb.frame_stop_reason_string} to convert the value returned by this
-function to a string.
+function to a string. The value can be one of:
+@table @code
+No particular reason (older frames should be available).
+The previous frame's analyzer returns an invalid result.
+This frame is the outermost.
+Cannot unwind further, because that would require knowing the 
+values of registers or memory that have not been collected.
+This frame ID looks like it ought to belong to a NEXT frame,
+but we got it for a PREV frame.  Normally, this is a sign of
+unwinder failure.  It could also indicate stack corruption.
+This frame has the same ID as the previous one.  That means
+that unwinding further would almost certainly give us another
+frame with exactly the same ID, so break the chain.  Normally,
+this is a sign of unwinder failure.  It could also indicate
+stack corruption.
+The frame unwinder did not find any saved PC, but we needed
+one to unwind further.
+@end table
 @end defun
 @defun Frame.pc ()

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]