PR python/13285 Document named constants for frame unwind stop reasons

* gdb.texinfo (Frames In Python): Document gdb.FRAME_UNWIND_*
	constants.
This commit is contained in:
Kevin Pouget 2011-10-13 14:50:08 +00:00
parent 2ff6b08097
commit a7fc3f37d4
2 changed files with 39 additions and 1 deletions

View File

@ -1,3 +1,9 @@
2011-10-13 Kevin Pouget <kevin.pouget@st.com>
PR python/13285 Document named constants for frame unwind stop reasons
* gdb.texinfo (Frames In Python): Document gdb.FRAME_UNWIND_*
constants.
2011-10-12 Jan Kratochvil <jan.kratochvil@redhat.com>
Fix compatibility with texinfo versions older than 4.12.

View File

@ -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
@item gdb.FRAME_UNWIND_NO_REASON
No particular reason (older frames should be available).
@item gdb.FRAME_UNWIND_NULL_ID
The previous frame's analyzer returns an invalid result.
@item gdb.FRAME_UNWIND_OUTERMOST
This frame is the outermost.
@item gdb.FRAME_UNWIND_UNAVAILABLE
Cannot unwind further, because that would require knowing the
values of registers or memory that have not been collected.
@item gdb.FRAME_UNWIND_INNER_ID
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.
@item gdb.FRAME_UNWIND_SAME_ID
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.
@item gdb.FRAME_UNWIND_NO_SAVED_PC
The frame unwinder did not find any saved PC, but we needed
one to unwind further.
@end table
@end defun
@defun Frame.pc ()