Re: [rfc] Infrastructure to disable breakpoints during inferior startup

[Michael Snyder <msnyder@vmware.com>]

Eli Zaretskii wrote:
>> Cc: eliz@gnu.org, thiago.bauermann@gmail.com (Thiago Jung Bauermann),
>>         gdb-patches@sourceware.org, pedro@codesourcery.com,
>>         jkratoch@redhat.com
>> From: Tom Tromey <tromey@redhat.com>
>> Date: Thu, 06 Aug 2009 09:58:54 -0600
>>
>> 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.
> 
> That's one reason for the internals manual.  The other -- which IMO is
> a more important one (but I'm in minority here) -- is that Texinfo
> allows you to organize the documentation for easy reading in ways code
> comments never will.  You cannot have index entries in comments, and
> you cannot have cross-references which are easy to be followed, two
> features without which reading about a complicated topic described in
> several places is a PITA.
> 
> So ideally, we should have both code comments and corresponding manual
> docs, IMO.

I'm with Eli, FWIW.  We need both.
We'll never document everything in the internals manual,
but the more the better.