From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 10808 invoked by alias); 2 Aug 2010 23:23:06 -0000 Received: (qmail 10800 invoked by uid 22791); 2 Aug 2010 23:23:05 -0000 X-SWARE-Spam-Status: No, hits=-1.8 required=5.0 tests=AWL,BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM X-Spam-Check-By: sourceware.org Received: from mail-fx0-f47.google.com (HELO mail-fx0-f47.google.com) (209.85.161.47) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Mon, 02 Aug 2010 23:22:59 +0000 Received: by fxm12 with SMTP id 12so2121374fxm.20 for ; Mon, 02 Aug 2010 16:22:57 -0700 (PDT) MIME-Version: 1.0 Received: by 10.239.165.13 with SMTP id v13mr240212hbd.198.1280791377221; Mon, 02 Aug 2010 16:22:57 -0700 (PDT) Received: by 10.239.160.146 with HTTP; Mon, 2 Aug 2010 16:22:57 -0700 (PDT) In-Reply-To: <11008022317.AA08984@vlsi1.ultra.nyu.edu> References: <4BFC6EF0.4090908@codesourcery.com> <20100714172307.3687a9c4@shotwell> <4C48D2C4.5000103@codesourcery.com> <4C48D60E.3000604@codesourcery.com> <20100726175013.20b12428@shotwell> <4C4E35B8.6010301@codesourcery.com> <4C4E37FC.1060208@adacore.com> <4C4F010C.5060401@codesourcery.com> <20100727180738.GU17485@synopsys.com> <4C4F20E8.5050206@codesourcery.com> <4C509E54.6090401@codesourcery.com> <11007291247.AA02219@vlsi1.ultra.nyu.edu> <4C5195FA.2060208@codesourcery.com> <4C52B176.7040807@adacore.com> <4C52E1C0.6090400@codesourcery.com> <4C53696B.7030801@adacore.com> <4C536B50.4010402@codesourcery.com> <11008022317.AA08984@vlsi1.ultra.nyu.edu> Date: Mon, 02 Aug 2010 23:23:00 -0000 Message-ID: Subject: Re: GFDL/GPL issues From: Steven Bosscher To: Richard Kenner Cc: dnovillo@google.com, Joe.Buck@synopsys.com, ams@gnu.org, bkoz@redhat.com, dewar@adacore.com, gcc@gcc.gnu.org, iant@google.com, mark@codesourcery.com, richard.guenther@gmail.com Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable Mailing-List: contact gcc-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Id: List-Archive: List-Post: List-Help: Sender: gcc-owner@gcc.gnu.org X-SW-Source: 2010-08/txt/msg00016.txt.bz2 On Tue, Aug 3, 2010 at 1:17 AM, Richard Kenner wrote: >> We are already having trouble keeping our documentation up-to-date. >> Some of it is in such a poor shape as to be laughable. =A0Yes, it's >> mostly our fault, but if we were able to generate documentation by >> simply extracting it from the code. =A0Tools exist for this, and >> properly maintained, they are very useful. > > I disagree and think that's backwards. =A0To get good quality > documentation, we have to WRITE good quality documentation. That is true, but very often the documentation is needed in two places: in the code and in the manual. Especially for things like machine constraints, flags and options. And even if the documentation isn't needed in two places to, well, document something, it may still be useful to automatically generate parts of manual to avoid divergence between the manual and the compiler. But as it is, the good quality documentation cannot be written in the code.= .. Ciao! Steven