From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 97032 invoked by alias); 26 Apr 2019 16:48:41 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 96846 invoked by uid 89); 26 Apr 2019 16:48:23 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-1.9 required=5.0 tests=BAYES_00,KAM_SHORT,RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 spammy= X-HELO: mail-wm1-f46.google.com Received: from mail-wm1-f46.google.com (HELO mail-wm1-f46.google.com) (209.85.128.46) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 26 Apr 2019 16:48:22 +0000 Received: by mail-wm1-f46.google.com with SMTP id n25so5286505wmk.4 for ; Fri, 26 Apr 2019 09:48:13 -0700 (PDT) Return-Path: Received: from ?IPv6:2001:8a0:f913:f700:4c97:6d52:2cea:997b? ([2001:8a0:f913:f700:4c97:6d52:2cea:997b]) by smtp.gmail.com with ESMTPSA id s12sm22371455wmj.42.2019.04.26.09.48.11 (version=TLS1_3 cipher=AEAD-AES128-GCM-SHA256 bits=128/128); Fri, 26 Apr 2019 09:48:11 -0700 (PDT) Subject: Re: [PATCH+8.3?] Implement dump of mappings with ELF headers by gcore To: Kevin Buettner , gdb-patches@sourceware.org References: <20190423234635.26916-1-sergiodj@redhat.com> <20190425102100.08da12eb@f29-4.lan> <87mukec594.fsf@redhat.com> <20190425140431.37bd03fc@f29-4.lan> Cc: Sergio Durigan Junior From: Pedro Alves Message-ID: <1c06b260-0cf0-32b1-31db-3fb4a54896c8@redhat.com> Date: Fri, 26 Apr 2019 16:48:00 -0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.2.1 MIME-Version: 1.0 In-Reply-To: <20190425140431.37bd03fc@f29-4.lan> Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-SW-Source: 2019-04/txt/msg00575.txt.bz2 On 4/25/19 10:04 PM, Kevin Buettner wrote: > On Thu, 25 Apr 2019 14:24:39 -0400 > Sergio Durigan Junior 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 : "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