This is the mail archive of the
gdb@sourceware.org
mailing list for the GDB project.
Re: A new strategy for internals documentation
- From: Tom Tromey <tromey at redhat dot com>
- To: Stan Shebs <stanshebs at earthlink dot net>
- Cc: GDB Development <gdb at sourceware dot org>
- Date: Thu, 08 Aug 2013 14:41:17 -0600
- Subject: Re: A new strategy for internals documentation
- References: <5201781A dot 3000607 at earthlink dot net>
>>>>> "Stan" == Stan Shebs <stanshebs@earthlink.net> writes:
Stan> Although GDB has had an internals manual for many years, nobody has
Stan> been especially happy with it. It is perennially out of date,
Stan> sometimes majorly so, and it is quite incomplete. With the passage of
Stan> time, the whole idea of an internals manual has come to seem like a
Stan> throwback to the old days, when the prospective GDB hacker's
Stan> information had to come from either printed books, or tape archives
Stan> downloaded from an FTP site.
Stan> Various ideas for how to fix have been floating around, generally with
Stan> the goal of improving the manual somehow, but nothing has developed
Stan> into action.
Stan> I propose a two-pronged strategy, first migrating the internals manual
Stan> to the wiki, and then introducing Doxygen for source code
Stan> documentation.
It all sounds good to me. Please get started :-)
Tom