From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 5752 invoked by alias); 4 Mar 2014 19:15:38 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 5741 invoked by uid 89); 4 Mar 2014 19:15:37 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.9 required=5.0 tests=AWL,BAYES_00,SPF_SOFTFAIL autolearn=no version=3.3.2 X-HELO: mtaout28.012.net.il Received: from mtaout28.012.net.il (HELO mtaout28.012.net.il) (80.179.55.184) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Tue, 04 Mar 2014 19:15:36 +0000 Received: from conversion-daemon.mtaout28.012.net.il by mtaout28.012.net.il (HyperSendmail v2007.08) id <0N1X00I00ESV2L00@mtaout28.012.net.il> for gdb-patches@sourceware.org; Tue, 04 Mar 2014 21:15:46 +0200 (IST) Received: from HOME-C4E4A596F7 ([87.69.4.28]) by mtaout28.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0N1X0069NEUAK970@mtaout28.012.net.il>; Tue, 04 Mar 2014 21:15:46 +0200 (IST) Date: Tue, 04 Mar 2014 19:15:00 -0000 From: Eli Zaretskii Subject: Re: [PATCH] Doxygenate gdbtypes.h In-reply-to: <53162394.3030604@earthlink.net> To: Stan Shebs Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83txbdrd10.fsf@gnu.org> MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-transfer-encoding: 8BIT References: <53151B5D.5000309@earthlink.net> <201403040039.s240db0w008027@glazunov.sibelius.xs4all.nl> <531529D4.3050309@earthlink.net> <8761ntoogy.fsf@gnu.org> <53162394.3030604@earthlink.net> X-IsSubscribed: yes X-SW-Source: 2014-03/txt/msg00094.txt.bz2 > Date: Tue, 04 Mar 2014 11:03:48 -0800 > From: Stan Shebs > > > 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.