This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] Doxygenate gdbtypes.h
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Stan Shebs <stanshebs at earthlink dot net>
- Cc: gdb-patches at sourceware dot org
- Date: Tue, 04 Mar 2014 21:15:23 +0200
- Subject: Re: [PATCH] Doxygenate gdbtypes.h
- Authentication-results: sourceware.org; auth=none
- References: <53151B5D dot 5000309 at earthlink dot net> <201403040039 dot s240db0w008027 at glazunov dot sibelius dot xs4all dot nl> <531529D4 dot 3050309 at earthlink dot net> <8761ntoogy dot fsf at gnu dot org> <53162394 dot 3030604 at earthlink dot net>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Tue, 04 Mar 2014 11:03:48 -0800
> From: Stan Shebs <stanshebs@earthlink.net>
>
> > Just because some GNU packages use Doxygen (or CMake, or...) doesnât
> > mean itâs a good idea; and it remains a GCS violation.
>
> Paragraph and sentence, please?
>From the "GNU Manuals" node:
The preferred document format for the GNU system is the Texinfo
formatting language. Every GNU package should (ideally) have
documentation in Texinfo both for reference and for learners. Texinfo
makes it possible to produce a good quality formatted book, using TeX,
and to generate an Info file. It is also possible to generate HTML
output from Texinfo source. See the Texinfo manual, either the
hardcopy, or the on-line version available through `info' or the Emacs
Info subsystem (`C-h i').
Nowadays some other formats such as Docbook and Sgmltexi can be
converted automatically into Texinfo. It is ok to produce the Texinfo
documentation by conversion this way, as long as it gives good results.