This is the mail archive of the
gdb@sourceware.org
mailing list for the GDB project.
Re: A new strategy for internals documentation
- From: Stan Shebs <stanshebs at earthlink dot net>
- To: Eli Zaretskii <eliz at gnu dot org>
- Cc: Doug Evans <dje at google dot com>, gdb at sourceware dot org
- Date: Thu, 08 Aug 2013 16:02:58 -0700
- Subject: Re: A new strategy for internals documentation
- References: <5201781A dot 3000607 at earthlink dot net> <83k3jyunt8 dot fsf at gnu dot org> <5202A6D6 dot 8090908 at earthlink dot net> <83li4ct7ot dot fsf at gnu dot org> <CADPb22ToXn8aypnpyHEFrUw_yQQiib=ieCj7WbQLSaZQM00RVg at mail dot gmail dot com> <8361vfu9t4 dot fsf at gnu dot org>
I'm not sure what we're arguing at this point, so let me see if I can
summarize your views on specific actions:
1. Delete gdbint.texinfo.
We're all agreed on this, right?
2. Add pieces of the manual to the wiki.
You doubt the value of this. Should we forbid people from adding wiki
pages?
3. Introduce an annotation/structured scheme in source code comments.
You're skeptical, but not opposed to this, right?
4. Use Doxygen.
Are you for or against, or indifferent?
(For me Doxygen gets the nod by elimination, if nothing else. In the
rather lengthy
http://en.wikipedia.org/wiki/Comparison_of_documentation_generators
there are not a lot of options that are portable, GPL, etc. LLVM's use
of Doxygen, http://llvm.org/doxygen/index.html , seems pretty useful.)
Stan
stan@codesourcery.com