From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 13778 invoked by alias); 9 Aug 2013 23:32:06 -0000 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 Received: (qmail 13769 invoked by uid 89); 9 Aug 2013 23:32:06 -0000 X-Spam-SWARE-Status: No, score=-2.5 required=5.0 tests=AWL,BAYES_05,FREEMAIL_FROM,KHOP_THREADED,RCVD_IN_DNSWL_LOW,RCVD_IN_HOSTKARMA_YE,RDNS_NONE,SPF_PASS autolearn=ham version=3.3.1 Received: from Unknown (HELO mail-lb0-f171.google.com) (209.85.217.171) by sourceware.org (qpsmtpd/0.84/v0.84-167-ge50287c) with ESMTP; Fri, 09 Aug 2013 23:32:05 +0000 Received: by mail-lb0-f171.google.com with SMTP id t13so3631260lbd.30 for ; Fri, 09 Aug 2013 16:31:57 -0700 (PDT) MIME-Version: 1.0 X-Received: by 10.112.205.106 with SMTP id lf10mr3312139lbc.77.1376091117018; Fri, 09 Aug 2013 16:31:57 -0700 (PDT) Received: by 10.114.3.76 with HTTP; Fri, 9 Aug 2013 16:31:56 -0700 (PDT) In-Reply-To: <52056DC4.4040109@earthlink.net> References: <5201781A.3000607@earthlink.net> <83k3jyunt8.fsf@gnu.org> <52031434.2080005@codesourcery.com> <83k3jwt7in.fsf@gnu.org> <201308090129.r791Tw6a016114@new.toad.com> <52056DC4.4040109@earthlink.net> Date: Fri, 09 Aug 2013 23:32:00 -0000 Message-ID: Subject: Re: A new strategy for internals documentation From: Matt Rice To: Stan Shebs Cc: GDB Content-Type: text/plain; charset=ISO-8859-1 X-SW-Source: 2013-08/txt/msg00059.txt.bz2 On Fri, Aug 9, 2013 at 3:31 PM, Stan Shebs wrote: > If there were > a half-dozen files to edit in sync, these days there is more likely to > be intense pressure to refactor that code and bring it back down to one > place to edit to me this is the most important thing, that anything that belongs in the source code, shouldn't need to be duplicated in the manual, and have to be kept in sync. I personally don't care if that manual is wiki/texinfo but by removing all the stuff thats already in/belongs in the source code, the manual will be smaller and easier to keep in sync. as I said I don't care much about wiki/texinfo argument but it would be nice if the manual could link directly to the doxygen documentation, in those places where there is currently duplicate information. The wiki makes that very easy with hyperlinks, If its easy with texinfo thats fine with me too... I don't think doxygen is the greatest thing ever, but if it gives the internals manual an iota of a chance at staying relevent by drawing a line in the sand the manual does not cross and reducing the churn, it will be worth its while.