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

[Tom Tromey <tromey@redhat.com>]

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