From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 3491 invoked by alias); 22 Dec 2007 06:23:39 -0000 Received: (qmail 3481 invoked by uid 22791); 22 Dec 2007 06:23:39 -0000 X-Spam-Check-By: sourceware.org Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.31) with ESMTP; Sat, 22 Dec 2007 06:23:19 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 86A7E2A96AD; Sat, 22 Dec 2007 01:23:17 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id 5Ql+I8wkR0qZ; Sat, 22 Dec 2007 01:23:17 -0500 (EST) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 899702A96A9; Sat, 22 Dec 2007 01:23:16 -0500 (EST) Received: by joel.gnat.com (Postfix, from userid 1000) id F299FE7ACA; Sat, 22 Dec 2007 10:22:23 +0400 (RET) Date: Sat, 22 Dec 2007 06:27:00 -0000 From: Joel Brobecker To: Eli Zaretskii Cc: uweigand@de.ibm.com, gdb-patches@sourceware.org Subject: Re: [RFC/RFA] Introduce new struct parse_context Message-ID: <20071222062223.GT6154@adacore.com> References: <20071217064213.GC9022@adacore.com> <20071221043608.GJ6154@adacore.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.4.2.2i 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 X-SW-Source: 2007-12/txt/msg00391.txt.bz2 > > If we were to put some documentation in gdbint for this patch, > > what would you put? > > Both. This is a significant new feature, and at least its main > principles should be described in gdbint, enough to get the reader off > the ground with the knowledge she could use to find the parts of code > which implement this feature (and read the comments there ;-). I don't see what you would describe in the documentation that would not be in the code as a comment. I think I don't see what to say because I don't see this patch as a significant new feature, but as a modification whose purpose is to fix a bug (the parser uses the global current_language) to do the parsing, but this global gets overwritten as a side effect of a function called between the moment we set the current_language and the moment we actually do the parsing). How about the following compromise: I describe again roughly what the problem is and how I am going to address it. Then you can decide what to add to gdbint, and where. I would appreciate your help in writing that addition, because I just simply suck in writing documentations, and as a result, I'm really slow. Just the time it takes me to write good comments makes me mad, sometimes. -- Joel