From patchwork Thu Dec 18 18:26:04 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Marchi X-Patchwork-Id: 4348 Received: (qmail 11957 invoked by alias); 18 Dec 2014 18:26:13 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 11935 invoked by uid 89); 18 Dec 2014 18:26:10 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.0 required=5.0 tests=AWL, BAYES_00, SPF_PASS autolearn=ham version=3.3.2 X-HELO: usevmg20.ericsson.net Received: from usevmg20.ericsson.net (HELO usevmg20.ericsson.net) (198.24.6.45) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Thu, 18 Dec 2014 18:26:08 +0000 Received: from EUSAAHC004.ericsson.se (Unknown_Domain [147.117.188.84]) by usevmg20.ericsson.net (Symantec Mail Security) with SMTP id AB.18.03307.07BC2945; Thu, 18 Dec 2014 13:41:20 +0100 (CET) Received: from [142.133.110.254] (147.117.188.8) by smtps-am.internal.ericsson.com (147.117.188.84) with Microsoft SMTP Server (TLS) id 14.3.195.1; Thu, 18 Dec 2014 13:26:06 -0500 Message-ID: <54931C3C.6030101@ericsson.com> Date: Thu, 18 Dec 2014 13:26:04 -0500 From: Simon Marchi User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.3.0 MIME-Version: 1.0 To: Doug Evans CC: gdb-patches Subject: Re: [PATCH] A few comment cleanups References: <1418842893-21536-1-git-send-email-simon.marchi@ericsson.com> <5491F976.50804@ericsson.com> In-Reply-To: X-IsSubscribed: yes On 2014-12-17 05:30 PM, Doug Evans wrote: > On Wed, Dec 17, 2014 at 1:45 PM, Simon Marchi wrote: >> On 2014-12-17 02:37 PM, Doug Evans wrote: >>> On Wed, Dec 17, 2014 at 11:01 AM, Simon Marchi >>> wrote: >>>> I stumbled upon a few comments that I think are outdated. >>>> >>>> Comment for elfread.c (elf_symfile_init): As far as history goes in git, >>>> I don't see anything related to that. >>>> >>>> Comment for elfread.c (elf_symfile_read): References a parameter that was >>>> removed in 1999. >>>> >>>> Comment for struct sym_fns/sym_offsets: References a parameter that was >>>> changed in 1999. >>>> >>>> gdb/ChangeLog: >>>> >>>> * elfread.c (elf_symfile_init): Remove stale comment. >>>> (elf_symfile_read): Same. >>>> * symfile.h (struct sym_fns): Same. >>> >>> Hi. >>> Ok with one nit, below. >>> >>>> --- >>>> gdb/elfread.c | 13 +------------ >>>> gdb/symfile.h | 6 +----- >>>> 2 files changed, 2 insertions(+), 17 deletions(-) >>>> >>>> diff --git a/gdb/elfread.c b/gdb/elfread.c >>>> index b4ec067..93e5045 100644 >>>> --- a/gdb/elfread.c >>>> +++ b/gdb/elfread.c >>>> @@ -1236,10 +1236,6 @@ elf_read_minimal_symbols (struct objfile *objfile, int symfile_flags, >>>> We have been initialized by a call to elf_symfile_init, which >>>> currently does nothing. >>>> >>>> - SECTION_OFFSETS is a set of offsets to apply to relocate the symbols >>>> - in each section. We simplify it down to a single offset for all >>>> - symbols. FIXME. >>>> - >>>> This function only does the minimum work necessary for letting the >>>> user "name" things symbolically; it does not read the entire symtab. >>>> Instead, it reads the external and static symbols and puts them in partial >>>> @@ -1418,14 +1414,7 @@ elf_symfile_finish (struct objfile *objfile) >>>> dwarf2_free_objfile (objfile); >>>> } >>>> >>>> -/* ELF specific initialization routine for reading symbols. >>>> - >>>> - It is passed a pointer to a struct sym_fns which contains, among other >>>> - things, the BFD for the file whose symbols are being read, and a slot for >>>> - a pointer to "private data" which we can fill with goodies. >>>> - >>>> - For now at least, we have nothing in particular to do, so this function is >>>> - just a stub. */ >>>> +/* ELF specific initialization routine for reading symbols. */ >>>> >>>> static void >>>> elf_symfile_init (struct objfile *objfile) >>>> diff --git a/gdb/symfile.h b/gdb/symfile.h >>>> index 1e8c230..b2cb089 100644 >>>> --- a/gdb/symfile.h >>>> +++ b/gdb/symfile.h >>>> @@ -354,11 +354,7 @@ struct sym_fns >>>> void (*sym_finish) (struct objfile *); >>>> >>>> /* This function produces a file-dependent section_offsets >>>> - structure, allocated in the objfile's storage, and based on the >>>> - parameter. The parameter is currently a CORE_ADDR (FIXME!) for >>>> - backward compatibility with the higher levels of GDB. It should >>>> - probably be changed to a string, where NULL means the default, >>>> - and others are parsed in a file dependent way. */ >>>> + structure, allocated in the objfile's storage. */ >>>> >>>> void (*sym_offsets) (struct objfile *, const struct section_addr_info *); >>> >>> Can I ask you to document what the struct section_addr_info * argument is for? >>> >> >> Hmm I am not sure my knowledge allows me to produce a useful comment. Don't hesitate to >> correct/enhance. Here is my first shot, after a bit of code reading: >> >> /* This function produces a file-dependent section_offsets >> structure, allocated in the objfile's storage. >> >> The section_addr_info structure contains the offset of loadable and >> allocated sections, relative to the absolute offsets found in the BFD. */ >> >> void (*sym_offsets) (struct objfile *, const struct section_addr_info *); > > "works for me" > > Thanks! Pushed with that change, thanks! From db7a9bcd53534a32abf4d75a93838c6bdbf876fa Mon Sep 17 00:00:00 2001 From: Simon Marchi Date: Thu, 18 Dec 2014 11:39:44 -0500 Subject: [PATCH] A few comment cleanups I stumbled upon a few comments that I think are outdated. Comment for elfread.c (elf_symfile_init): As far as history goes in git, I don't see anything related to that. Comment for elfread.c (elf_symfile_read): References a parameter that was removed in 1999. Comment for struct sym_fns/sym_offsets: References a parameter that was changed in 1999. gdb/ChangeLog: * elfread.c (elf_symfile_init): Remove stale comment. (elf_symfile_read): Same. * symfile.h (struct sym_fns): Same. --- gdb/ChangeLog | 6 ++++++ gdb/elfread.c | 13 +------------ gdb/symfile.h | 10 +++++----- 3 files changed, 12 insertions(+), 17 deletions(-) diff --git a/gdb/ChangeLog b/gdb/ChangeLog index 348a48f..adb24d4 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,9 @@ +2014-12-18 Simon Marchi + + * elfread.c (elf_symfile_init): Remove stale comment. + (elf_symfile_read): Same. + * symfile.h (struct sym_fns): Same. + 2014-12-18 Nigel Stephens Maciej W. Rozycki diff --git a/gdb/elfread.c b/gdb/elfread.c index b4ec067..93e5045 100644 --- a/gdb/elfread.c +++ b/gdb/elfread.c @@ -1236,10 +1236,6 @@ elf_read_minimal_symbols (struct objfile *objfile, int symfile_flags, We have been initialized by a call to elf_symfile_init, which currently does nothing. - SECTION_OFFSETS is a set of offsets to apply to relocate the symbols - in each section. We simplify it down to a single offset for all - symbols. FIXME. - This function only does the minimum work necessary for letting the user "name" things symbolically; it does not read the entire symtab. Instead, it reads the external and static symbols and puts them in partial @@ -1418,14 +1414,7 @@ elf_symfile_finish (struct objfile *objfile) dwarf2_free_objfile (objfile); } -/* ELF specific initialization routine for reading symbols. - - It is passed a pointer to a struct sym_fns which contains, among other - things, the BFD for the file whose symbols are being read, and a slot for - a pointer to "private data" which we can fill with goodies. - - For now at least, we have nothing in particular to do, so this function is - just a stub. */ +/* ELF specific initialization routine for reading symbols. */ static void elf_symfile_init (struct objfile *objfile) diff --git a/gdb/symfile.h b/gdb/symfile.h index 1e8c230..081bc4e 100644 --- a/gdb/symfile.h +++ b/gdb/symfile.h @@ -353,12 +353,12 @@ struct sym_fns void (*sym_finish) (struct objfile *); + /* This function produces a file-dependent section_offsets - structure, allocated in the objfile's storage, and based on the - parameter. The parameter is currently a CORE_ADDR (FIXME!) for - backward compatibility with the higher levels of GDB. It should - probably be changed to a string, where NULL means the default, - and others are parsed in a file dependent way. */ + structure, allocated in the objfile's storage. + + The section_addr_info structure contains the offset of loadable and + allocated sections, relative to the absolute offsets found in the BFD. */ void (*sym_offsets) (struct objfile *, const struct section_addr_info *);