From: Pedro Alves <pedro@codesourcery.com>
To: gdb-patches@sourceware.org
Cc: Joel Brobecker <brobecker@adacore.com>,
Thiago Jung Bauermann <bauerman@br.ibm.com>
Subject: Re: [RFA] Refactor breakpoint_re_set_one
Date: Mon, 28 Mar 2011 20:24:00 -0000 [thread overview]
Message-ID: <201103282123.00694.pedro@codesourcery.com> (raw)
In-Reply-To: <20110328184647.GD3670@adacore.com>
On Monday 28 March 2011 19:46:47, Joel Brobecker wrote:
> > +/* Find the SaL locations corresponding to the given addr_string. */
>
> By convention `addr_string' should be capitalized.
> It's one of these things I really wonder why we do it, but anyways...
Wonder no more. :-)
From <http://www.gnu.org/prep/standards/standards.html#Comments>,
5.2 Commenting Your Work:
The comment on a function is much clearer if you use the argument names to
speak about the argument values. The variable name itself should be lower case,
but write it in upper case when you are speaking about the value rather
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
than the variable itself. Thus, "the inode number NODE_NUM" rather than "an inode".
^^^^^^^^^^^^^^^^^^^^^^^^
Thus, this is not restricted, or really specific of function arguments.
--
Pedro Alves
next prev parent reply other threads:[~2011-03-28 20:23 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-03-28 15:18 Thiago Jung Bauermann
2011-03-28 20:08 ` Joel Brobecker
2011-03-28 20:24 ` Pedro Alves [this message]
2011-03-29 1:40 ` Thiago Jung Bauermann
2011-03-29 1:55 ` Joel Brobecker
2011-03-29 12:36 ` Ulrich Weigand
2011-03-31 14:46 ` Thiago Jung Bauermann
2011-03-31 14:37 ` [commit] Fix uninitialized warning (Re: [RFA] Refactor breakpoint_re_set_one) Ulrich Weigand
2011-03-31 15:03 ` Thiago Jung Bauermann
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=201103282123.00694.pedro@codesourcery.com \
--to=pedro@codesourcery.com \
--cc=bauerman@br.ibm.com \
--cc=brobecker@adacore.com \
--cc=gdb-patches@sourceware.org \
/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