aboutsummaryrefslogtreecommitdiff
path: root/gdb
diff options
context:
space:
mode:
authorKevin Pouget <kpouget@sourceware.org>2011-10-13 14:50:08 +0000
committerKevin Pouget <kpouget@sourceware.org>2011-10-13 14:50:08 +0000
commita7fc3f37d47e196365f04fea7e1f17b4d56b83e4 (patch)
tree34ccf02a300a2558d60fe0d884a763d827c14df2 /gdb
parent2ff6b08097f66c4d0efe9ec9902a8bbbab3c4629 (diff)
downloadgdb-a7fc3f37d47e196365f04fea7e1f17b4d56b83e4.zip
gdb-a7fc3f37d47e196365f04fea7e1f17b4d56b83e4.tar.gz
gdb-a7fc3f37d47e196365f04fea7e1f17b4d56b83e4.tar.bz2
PR python/13285 Document named constants for frame unwind stop reasons
* gdb.texinfo (Frames In Python): Document gdb.FRAME_UNWIND_* constants.
Diffstat (limited to 'gdb')
-rw-r--r--gdb/doc/ChangeLog6
-rw-r--r--gdb/doc/gdb.texinfo34
2 files changed, 39 insertions, 1 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 1512909..e97cd8b 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -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.
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
+@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 ()