This is the mail archive of the mailing list for the GDB project.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: FYI: minsyms documentation

> Date: Sat, 24 Dec 2011 11:47:57 +0800
> From: Yao Qi <>
> newbies are learning by manual reading at the beginning

Then they will learn a lot of incorrect things at the beginning.

> In JDK, all the documentation to a class and its methods are written in
> source file, and only one small text file is for package description.
> In package description, the overview is given and relationship of these
> classes is described.  Most of the doc in details are still in comment
> of source file.  I don't think we can copy this approach here, but we
> can do something similar here.  Put detailed doc in gdbint.texinfo to
> relevant source files, and only leave overview and high-level doc in it.
>  In this way, we don't have to pay much effort to keep gdbint.texinfo
> synchronized with source, and gdbint.texinfo is still quite useful.

Take a look at libiberty and at bfd: they use something very similar.
We could do the same with gdbint.texinfo (I think I proposed that as
well some time ago, but no one was for it).

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]