From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 25048 invoked by alias); 13 Oct 2009 08:23:53 -0000 Received: (qmail 25030 invoked by uid 22791); 13 Oct 2009 08:23:52 -0000 X-SWARE-Spam-Status: No, hits=-1.5 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from smtp.idnet.com (HELO smtp-out.idnet.com) (212.69.36.238) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 13 Oct 2009 08:23:44 +0000 Received: from localhost (unknown [127.0.0.1]) by smtp-out.idnet.com (Postfix) with ESMTP id E92A216F94A for ; Tue, 13 Oct 2009 08:23:41 +0000 (UTC) Received: from smtp-out.idnet.com ([127.0.0.1]) by localhost (smtp-out.idnet.com [127.0.0.1]) (amavisd-new, port 10040) with LMTP id L285rk2rpAw2 for ; Tue, 13 Oct 2009 09:23:39 +0100 (BST) Received: from mail.idnet.net.uk (mail.idnet.net.uk [212.69.36.63]) by smtp-out.idnet.com (Postfix) with ESMTP id 6BD9816F940 for ; Tue, 13 Oct 2009 09:23:39 +0100 (BST) Received: from [91.135.5.64] by mail.idnet.net.uk (GMS 15.02.3689/NU3963.00.7ca42f0c) with ESMTP id tgzzaaca for gdb@sourceware.org; Tue, 13 Oct 2009 09:23:34 +0100 Subject: Re: Documentation generated from sources proposal From: Jeremy Bennett Reply-To: jeremy.bennett@embecosm.com To: Eli Zaretskii Cc: Jan Kratochvil , gdb@sourceware.org In-Reply-To: <83tyy4igm2.fsf@gnu.org> References: <20091012161424.GA20603@host0.dyn.jankratochvil.net> <83tyy4igm2.fsf@gnu.org> Content-Type: text/plain Date: Tue, 13 Oct 2009 08:23:00 -0000 Message-Id: <1255422217.4479.47.camel@thomas> Mime-Version: 1.0 Content-Transfer-Encoding: 7bit X-AuthenticatedSender: jeremy.bennett.embecosm.com@idnet.net.uk X-IsSubscribed: yes Mailing-List: contact gdb-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-owner@sourceware.org X-SW-Source: 2009-10/txt/msg00233.txt.bz2 On Mon, 2009-10-12 at 20:58 +0200, Eli Zaretskii wrote: > > Date: Mon, 12 Oct 2009 18:14:24 +0200 > > From: Jan Kratochvil > > > > May the GDB project start using some tool to format documentation from the > > sources? One could move the appropriate parts of gdb/doc/gdbint.texinfo into > > gdb/*.c along the patches being submitted, keeping in gdb/doc/gdbint.texinfo > > only the abstract parts in the future. > > Assuming the license problem is resolved, I'll support this, provided > that someone steps forward to do the initial job of moving the > up-to-date parts of gdbint to the sources and developing the > infrastructure for processing comments into Texinfo. I support this approach - we use it in house all the time. Once the legal side is sorted out, I'm quite happy to contribute by migrating the relevant parts of gdbint to the sources. One suggestion: gtk-doc is not that general purpose. Doxygen (as recommended by the gtk-doc website) might prove a more flexible alternative. The one caveat is that neither of these programs can generate Texinfo, so generating .info files will be hard (all the other output formats, including man pages can be generated directly, at least by Doxygen). In principle it could be done (gtk-doc->docbook->texinfo->info or doxygen->XML->texinfo->info), but who knows what the output might end up like! ATB, Jeremy -- Tel: +44 (1590) 610184 Cell: +44 (7970) 676050 SkypeID: jeremybennett Email: jeremy.bennett@embecosm.com Web: www.embecosm.com