From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 27664 invoked by alias); 6 Aug 2009 16:01:14 -0000 Received: (qmail 27486 invoked by uid 22791); 6 Aug 2009 16:01:11 -0000 X-SWARE-Spam-Status: No, hits=-2.3 required=5.0 tests=AWL,BAYES_00,SPF_HELO_PASS,SPF_PASS X-Spam-Check-By: sourceware.org Received: from mx2.redhat.com (HELO mx2.redhat.com) (66.187.237.31) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 06 Aug 2009 16:01:03 +0000 Received: from int-mx2.corp.redhat.com (int-mx2.corp.redhat.com [172.16.27.26]) by mx2.redhat.com (8.13.8/8.13.8) with ESMTP id n76Fwu3n005640; Thu, 6 Aug 2009 11:58:56 -0400 Received: from ns3.rdu.redhat.com (ns3.rdu.redhat.com [10.11.255.199]) by int-mx2.corp.redhat.com (8.13.1/8.13.1) with ESMTP id n76FwtK1006011; Thu, 6 Aug 2009 11:58:55 -0400 Received: from opsy.redhat.com (ovpn01.gateway.prod.ext.phx2.redhat.com [10.5.9.1]) by ns3.rdu.redhat.com (8.13.8/8.13.8) with ESMTP id n76FwsUn012153; Thu, 6 Aug 2009 11:58:55 -0400 Received: by opsy.redhat.com (Postfix, from userid 500) id 524E437857C; Thu, 6 Aug 2009 09:58:54 -0600 (MDT) To: "Ulrich Weigand" Cc: eliz@gnu.org, thiago.bauermann@gmail.com (Thiago Jung Bauermann), gdb-patches@sourceware.org, pedro@codesourcery.com, jkratoch@redhat.com Subject: Re: [rfc] Infrastructure to disable breakpoints during inferior startup References: <200908051814.n75IED4s005139@d12av02.megacenter.de.ibm.com> From: Tom Tromey Reply-To: Tom Tromey Date: Thu, 06 Aug 2009 17:46:00 -0000 In-Reply-To: <200908051814.n75IED4s005139@d12av02.megacenter.de.ibm.com> (Ulrich Weigand's message of "Wed\, 5 Aug 2009 20\:14\:13 +0200 \(CEST\)") Message-ID: User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii 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: 2009-08/txt/msg00088.txt.bz2 Ulrich> I'll be happy to add documentation to gdbint.texinfo, but I'm Ulrich> not quite sure where to start. It seems to me that in many cases the documentation would be more helpful if it were near the things it documented. For example, consider all the text in gdbint.texinfo concerning cleanups. It is quite useful to read when one is new to GDB; I've pointed several people at it. However, I think that if it were comments near the declarations of cleanup functions in a header file, I probably would not have to point people to it -- they would read it naturally as a consequence of looking up calls to make_cleanup. Also, it is simpler to remember to require changes to comments near the code than to gdbint.texinfo. I think there is still a need for an internals document, because there are things worth documenting that don't have a natural location in a source file. I'm thinking of things like coding conventions, HIG guidelines for new commands, etc -- things that affect future decisions but that are not inherent in the code. Tom