From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16383 invoked by alias); 10 Mar 2003 19:01:32 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 16366 invoked from network); 10 Mar 2003 19:01:26 -0000 Received: from unknown (HELO takamaka.act-europe.fr) (209.53.16.215) by 172.16.49.205 with SMTP; 10 Mar 2003 19:01:26 -0000 Received: by takamaka.act-europe.fr (Postfix, from userid 507) id 31B71D34B6; Mon, 10 Mar 2003 11:01:18 -0800 (PST) Date: Mon, 10 Mar 2003 19:01:00 -0000 From: Joel Brobecker To: Eli Zaretskii Cc: gdb-patches@sources.redhat.com Subject: Re: [RFA/doco] Add documentation for observer.[hc] (gdbint.texinfo) Message-ID: <20030310190118.GE967@gnat.com> References: <20030309065155.GB966@gnat.com> <3942-Sun09Mar2003180333+0200-eliz@elta.co.il> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <3942-Sun09Mar2003180333+0200-eliz@elta.co.il> User-Agent: Mutt/1.4i X-SW-Source: 2003-03/txt/msg00224.txt.bz2 Thanks, Eli and Daniel, for reviewing this patch. I will make the recommended changes shortly, and send a followup patch. There is one change that I am reluctant to make: > > + The rationale for the current implementation of the Observer pattern > > + is described in @file{observer.c}. > > I'd suggest to copy that rationale from observer.c into the manual. In my past experience, the only cases when any document describing a piece of code remained up-to-date was when the document was embedded with the source. So if we want this description to be in the manual, and stay up-to-date, it needs to be automatically generated from the code. In the long term, the plan is to automatically generate observer.texi. How about placing a copy of the rationale in this appendix then? -- Joel