From: Andrew Cagney <ac131313@redhat.com>
To: Jim Ingham <jingham@apple.com>
Cc: gdb-patches@sources.redhat.com
Subject: Re: complete command doesn't work for files...
Date: Thu, 25 Sep 2003 19:41:00 -0000 [thread overview]
Message-ID: <3F7344EF.30407@redhat.com> (raw)
In-Reply-To: <1A6E465C-EF8B-11D7-BEC8-00039379E320@apple.com>
> Comments in code should not say why what is no longer in the code was incorrect... That is just confusing. So the text of the ChangeLog is not appropriate as a comment in the code.
From the change log doco:
> There's no need to describe the full purpose of the changes or how they work together. If you think that a change calls for explanation, you're probably right. Please do explain it--but please put the explanation in comments in the code, where people will see it whenever they see the code. For example, "New function" is enough for the change log when you add a function, because there should be a comment before the function definition to explain what it does.
The commentary should alert the user as to issues with the relevant
code, explaining, where applicable, why apparently simpler alternative
techniques don't work.
Andrew
next prev parent reply other threads:[~2003-09-25 19:41 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2003-09-24 23:14 Jim Ingham
2003-09-24 23:25 ` Joel Brobecker
2003-09-24 23:30 ` Andrew Cagney
2003-09-25 19:04 ` Jim Ingham
2003-09-25 19:41 ` Andrew Cagney [this message]
2003-09-27 4:36 ` Jim Blandy
2004-01-19 16:22 ` Daniel Jacobowitz
2004-01-20 22:19 ` Jim Ingham
2004-02-01 5:51 ` Daniel Jacobowitz
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=3F7344EF.30407@redhat.com \
--to=ac131313@redhat.com \
--cc=gdb-patches@sources.redhat.com \
--cc=jingham@apple.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