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

[Kevin Pouget]

On Thu, Oct 13, 2011 at 4:05 PM, Kevin Pouget <kevin.pouget@gmail.com> wrote:
> On Thu, Oct 13, 2011 at 3:48 PM, Eli Zaretskii <eliz@gnu.org> wrote:
>>
>> > From: Kevin Pouget <kevin.pouget@gmail.com>
>> > Date: Thu, 13 Oct 2011 14:39:16 +0200
>> > Cc: pmuldoon@redhat.com, gdb-patches@sourceware.org
>> >
>> > I've prepared a bit of documentation for these named constants, based
>> > on their comments in the source code.
>>
>> Thanks.
>>
>> > +@table @code
>> > +@item gdb.FRAME_UNWIND_NO_REASON
>> > +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  <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.
>

commited: http://sourceware.org/ml/gdb-cvs/2011-10/msg00112.html

thanks