From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 24379 invoked by alias); 9 Feb 2004 18:45:55 -0000 Mailing-List: contact gcc-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Archive: List-Post: List-Help: Sender: gcc-owner@gcc.gnu.org Received: (qmail 24367 invoked from network); 9 Feb 2004 18:45:53 -0000 Received: from unknown (HELO mail.codesourcery.com) (65.74.133.6) by sources.redhat.com with SMTP; 9 Feb 2004 18:45:53 -0000 Received: (qmail 1790 invoked from network); 9 Feb 2004 18:45:52 -0000 Received: from taltos.codesourcery.com (zack@66.92.218.83) by mail.codesourcery.com with DES-CBC3-SHA encrypted SMTP; 9 Feb 2004 18:45:52 -0000 Received: by taltos.codesourcery.com (sSMTP sendmail emulation); Mon, 9 Feb 2004 10:45:51 -0800 From: "Zack Weinberg" To: kenner@vlsi1.ultra.nyu.edu (Richard Kenner) Cc: gcc@gcc.gnu.org Subject: Re: "Documentation by paper" References: <10402091840.AA07964@vlsi1.ultra.nyu.edu> Date: Mon, 09 Feb 2004 18:45:00 -0000 In-Reply-To: <10402091840.AA07964@vlsi1.ultra.nyu.edu> (Richard Kenner's message of "Mon, 9 Feb 04 13:40:32 EST") Message-ID: <87r7x41480.fsf@egil.codesourcery.com> User-Agent: Gnus/5.110002 (No Gnus v0.2) Emacs/21.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-SW-Source: 2004-02/txt/msg00558.txt.bz2 kenner@vlsi1.ultra.nyu.edu (Richard Kenner) writes: > You invented MEM_ATTRS and the adjust_address family of functions. > There is not one word about these things in doc/*.texi. > > I don't believe they should be there, but they should indeed be *somewhere*. Are you advocating that there should be no internals manual? I can see an argument for "no internals manual is necessary, just use comments in the code", and I can see an argument for "every internal interface should at least be mentioned in the internals manual", but not for some limbo state where there's no way to know if something is in the manual or not. > Write documentation for all this, to the standard you are advocating, > and let us see if it's good enough. > > Fair enough, though there was stuff added after I did the original work. Your original patches don't contain much in the way of documentation, either. zw