From: Eli Zaretskii <eliz@gnu.org>
To: Yao Qi <yao@codesourcery.com>
Cc: gdb-patches@sourceware.org
Subject: Re: FYI: minsyms documentation
Date: Sat, 24 Dec 2011 13:21:00 -0000 [thread overview]
Message-ID: <83obuyxvjl.fsf@gnu.org> (raw)
In-Reply-To: <4EF54B6D.907@codesourcery.com>
> Date: Sat, 24 Dec 2011 11:47:57 +0800
> From: Yao Qi <yao@codesourcery.com>
>
> 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).
next prev parent reply other threads:[~2011-12-24 7:45 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-22 4:44 Tom Tromey
2011-12-22 5:17 ` Joel Brobecker
2011-12-22 20:13 ` Stan Shebs
2011-12-22 20:21 ` Tom Tromey
2011-12-22 21:06 ` Eli Zaretskii
2011-12-23 4:21 ` Stan Shebs
2011-12-23 16:01 ` Eli Zaretskii
2012-01-02 22:08 ` Tom Tromey
2012-01-03 8:17 ` Eli Zaretskii
2011-12-24 7:45 ` Yao Qi
2011-12-24 13:21 ` Eli Zaretskii [this message]
2012-01-02 22:08 ` Tom Tromey
2012-01-03 8:18 ` Eli Zaretskii
2011-12-22 21:18 ` Stan Shebs
2011-12-23 10:38 ` Joel Brobecker
2012-01-02 22:14 ` Tom Tromey
2012-01-03 2:53 ` Joel Brobecker
2012-01-03 11:05 ` Pedro Alves
2012-01-03 13:21 ` commands.h and cli/cli-decode.h dups (was: Re: FYI: minsyms documentation) Pedro Alves
2012-01-03 14:57 ` commands.h and cli/cli-decode.h dups Tom Tromey
2012-01-03 17:11 ` Joel Brobecker
2012-01-05 11:40 ` Pedro Alves
2012-01-03 11:18 ` FYI: minsyms documentation Pedro Alves
2012-01-15 18:49 ` Michael Eager
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83obuyxvjl.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=yao@codesourcery.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox