This is the mail archive of the gdb-patches@sourceware.org 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


> 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.

> +@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.

OK with those changes.


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