This is the mail archive of the
mailing list for the GDB project.
Re: [Patch][Python] PR python/13285 Document named constants for frame unwind stop reasons
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Kevin Pouget <kevin dot pouget at gmail dot com>
- Cc: tromey at redhat dot com, pmuldoon at redhat dot com, gdb-patches at sourceware dot org
- Date: Thu, 13 Oct 2011 15:48:24 +0200
- Subject: Re: [Patch][Python] PR python/13285 Document named constants for frame unwind stop reasons
- References: <CAPftXUK4L-ihoc7h61sn+6zd1nK9JcQzaCNGiktvArodas3DzQ@mail.gmail.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> From: Kevin Pouget <email@example.com>
> Date: Thu, 13 Oct 2011 14:39:16 +0200
> Cc: firstname.lastname@example.org, email@example.com
> I've prepared a bit of documentation for these named constants, based
> on their comments in the source code.
> +@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:
Description of foo.
Description of bar.
OK with those changes.