Re: [RFA] Enhance GDB to break inside DSO init code

["Eli Zaretskii" <eliz@gnu.org>]

> Date: Sat, 24 Jul 2004 08:01:04 -0700
> From: Joel Brobecker <brobecker@gnat.com>
> 
> > Why, oh why do people go to such great lengths to explain this in a
> > mail message and/or in the comments to the code, but not as a patch to
> > gdbint.texinfo?  Why not invest a small additional effort (Texinfo
> > markup) to improve our documentation together with fixing a bug?
> 
> To me, explainations about the code belong in the code.

I didn't object to having them in the code as well.

The one significant drawback with having these explanations _only_ in
the code is that one cannot easily find them, unless one already knows
where and what to look for.  An Info manual, by contrast, has powerful
search facilities.

> If I had to make a suggestion, I would embed all the information from
> gdbint inside the code, and make gdbint a document generated from the
> code.

I support this goal, but I don't have time to work on making this
happen.  AFAIK, there's no GNU standard for embedding documentation in
code, and, apart of the chew thingy used by Binutils, I'm not aware of
any tools that can produce Texinfo.

Note that some background information doesn't belong to code comments,
so there will be a need for pure Texinfo somewhere even if we adopt
some self-documenting-code system.