Re: RFA: document frame types, plus add missing ones

[Mark Kettenis <mark.kettenis@xs4all.nl>]

> From: Tom Tromey <tromey@redhat.com>
> Date: Wed, 05 Jan 2011 12:52:50 -0700
> 
> This patch fixes PR python/12133.  The bug is that the return values for
> Frame.type are not documented.
> 
> While doing this, I noticed that we didn't expose all the frame types.
> So, this patch adds the missing ones as well.
> 
> Doc review needed.

> +@item gdb.INLINE_FRAME
> +A frame representing an inlined function.  The function was inlined
> +into a @code{gdb.NORMAL_FRAME} that is newer than this one.

It isn't quite clear to me what this last sentence means.

> +@item gdb.SIGTRAMP_FRAME
> +A frame in a signal handler.

Hmm, actualy, the frame for what most people consider the signal
handler is a NORMAL_FRAME.  The SIGTRAMP_FRAME is the frame
immediately preceding the signal handler.  It is for the "signal
trampoline", the bit of (low-level) code provided by the kernel or
libc that runs the true signal handler.

> +@item gdb.ARCH_FRAME
> +A fake stack frame representing a cross-architecture call.

Oh, we have those now?

> +@item gdb.SENTINEL_FRAME
> +This is like @code{gdb.NORMAL_FRAME}, but it is only used for the
> +newest frame.

Ah, so by "newest frame" you really mean "innermost frame".