From: Pedro Alves <palves@redhat.com>
To: Kevin Buettner <kevinb@redhat.com>, gdb-patches@sourceware.org
Cc: Sergio Durigan Junior <sergiodj@redhat.com>
Subject: Re: [PATCH+8.3?] Implement dump of mappings with ELF headers by gcore
Date: Fri, 26 Apr 2019 16:48:00 -0000 [thread overview]
Message-ID: <1c06b260-0cf0-32b1-31db-3fb4a54896c8@redhat.com> (raw)
In-Reply-To: <20190425140431.37bd03fc@f29-4.lan>
On 4/25/19 10:04 PM, Kevin Buettner wrote:
> On Thu, 25 Apr 2019 14:24:39 -0400
> Sergio Durigan Junior <sergiodj@redhat.com> wrote:
>
>>>> * linux-tdep.c (dump_mapping_p): Add new parameters "ADDR" and
>>>> "OFFSET". Verify if current mapping contains an ELF header.
>>>> (linux_find_memory_regions_full): Adjust call to
>>>> "dump_mapping_p".
>>>
>>> I don't think that the double quotes enclosing ADDR and OFFSET are
>>> needed here.
>>
>> Ah, OK. I tend to use them when I'm writing ChangeLog entries, but
>> that's a matter of style. I'll remove them.
>
> I think that quotes are appropriate when the actual names of the
> parameters are used. But (as I recall) the GNU convention is to
> change the names to all caps when referring to parameters in
> documentation. ChangeLog entries are a form of documenation, so no
> quotes.
All caps is used when referring to the values of the parameters, not
the parameters themselves.
From <https://www.gnu.org/prep/standards/standards.html>:
"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â. "
So in this case it should be lowercase, since you're talking about the name of
the variable/parameter.
I usually say "New parameter 'parameter'.", with single quotes. You can
find past examples in the ChangeLogs.
Thanks,
Pedro Alves
prev parent reply other threads:[~2019-04-26 16:48 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-23 23:46 Sergio Durigan Junior
2019-04-25 17:21 ` Kevin Buettner
2019-04-25 18:24 ` Sergio Durigan Junior
2019-04-25 21:04 ` Kevin Buettner
2019-04-26 16:45 ` Sergio Durigan Junior
2019-04-26 16:48 ` Pedro Alves [this message]
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=1c06b260-0cf0-32b1-31db-3fb4a54896c8@redhat.com \
--to=palves@redhat.com \
--cc=gdb-patches@sourceware.org \
--cc=kevinb@redhat.com \
--cc=sergiodj@redhat.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).