Mirror of the gdb mailing list
 help / color / mirror / Atom feed
From: Paul Koning <pkoning@equallogic.com>
To: dewar@adacore.com
Cc: jimb@codesourcery.com,     eager@eagercon.com,
	    stanshebs@earthlink.net,     gdb@sources.redhat.com
Subject: Re: What's an annex? stratum?
Date: Mon, 25 Jun 2007 19:48:00 -0000	[thread overview]
Message-ID: <18048.7178.168032.6683@pkoning.equallogic.com> (raw)
In-Reply-To: <4680199F.7020906@adacore.com>

>>>>> "Robert" == Robert Dewar <dewar@adacore.com> writes:

 Robert> On Mon, Jun 25, 2007 at 03:19:32PM -0400, Paul Koning wrote:
 >> That's really unfortunate.  Comments in code are useful but they
 >> are no substitute for properly written internals documentation.

 Robert> I disagree, properly arranged comments in the code can most
 Robert> certainly serve as internals documentation, and have a FAR
 Robert> better chance of being kept up to date. I am opposed to
 Robert> having separate internals documentation, I think it is much
 Robert> better to have this in the source files.

Usual practice is for source comments to be local explanation, not
global explanation.

But in any case, if internals documentation existed in the sources,
I'd be a happy camper.

    paul


  reply	other threads:[~2007-06-25 19:48 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-06-23 18:01 Michael Eager
2007-06-23 18:57 ` Stan Shebs
2007-06-23 19:08   ` Michael Eager
2007-06-23 19:47     ` Eli Zaretskii
2007-06-23 20:51       ` Michael Eager
2007-06-23 21:23         ` Daniel Jacobowitz
2007-06-23 21:40           ` Michael Eager
2007-06-24  2:58             ` Eli Zaretskii
2007-06-24  4:32               ` Michael Eager
2007-06-25 18:03     ` Jim Blandy
2007-06-25 18:39       ` Michael Eager
2007-06-25 19:10         ` Jim Blandy
2007-06-25 19:26           ` Paul Koning
2007-06-25 19:32             ` Daniel Jacobowitz
2007-06-25 19:38               ` Robert Dewar
2007-06-25 19:48                 ` Paul Koning [this message]
2007-06-25 20:09                   ` Michael Eager
2007-06-25 20:40                     ` Robert Dewar
2007-06-25 20:47                       ` Robert Dewar
2007-06-25 20:31                 ` Eli Zaretskii
2007-06-25 20:44                   ` Robert Dewar
2007-06-25 21:00                     ` Eli Zaretskii
2007-06-25 21:03                       ` Robert Dewar
2007-06-25 21:06                         ` Robert Dewar
2007-06-26 18:34                   ` Markus Deuling
2007-06-26 18:36                     ` Robert Dewar
2007-06-26 21:55                     ` Jim Blandy
2007-06-26 22:14                       ` Nick Roberts
2007-06-26 23:26                       ` Robert Dewar
2007-06-26 23:39                         ` Joel Brobecker
2007-06-26 23:43                           ` Robert Dewar
2007-06-27  0:32                             ` Jim Blandy
2007-06-27  0:42                               ` Robert Dewar
2007-06-27  3:22                                 ` Eli Zaretskii
2007-06-27  0:23                       ` Michael Eager
2007-06-25 20:42             ` Eli Zaretskii
2007-06-25 20:23           ` Eli Zaretskii
2007-06-25 21:52             ` Jim Blandy
2007-06-26  1:04               ` Paul Koning
2007-06-25 20:37         ` Eli Zaretskii
2007-06-25 20:15       ` Eli Zaretskii

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=18048.7178.168032.6683@pkoning.equallogic.com \
    --to=pkoning@equallogic.com \
    --cc=dewar@adacore.com \
    --cc=eager@eagercon.com \
    --cc=gdb@sources.redhat.com \
    --cc=jimb@codesourcery.com \
    --cc=stanshebs@earthlink.net \
    /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