Rename variable with confusing name

Message ID 1406930946-28195-1-git-send-email-simon.marchi@ericsson.com
State Committed
Headers

Commit Message

Simon Marchi Aug. 1, 2014, 10:09 p.m. UTC
  I saw this gem of not so legible code in solib-svr4.c (scan_dyntag):

	if (dyn_tag == dyntag)

and thought it deserved a small rename.

This just renames variables to be a bit more clear for those who read the
code. dyn_ptr was renamed as well to keep consistency. I also constified
the parameter because, why not.

Tested only by rebuilding, since the change was done mechanically.

gdb/Changelog:

2014-08-01  Simon Marchi  <simon.marchi@ericsson.com>

	* solib-svr4.c (scan_dyntag): Rename dyntag, dyn_tag and
	dyn_ptr variables.
---
 gdb/solib-svr4.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
  

Comments

Joel Brobecker Aug. 6, 2014, 1:17 p.m. UTC | #1
> I saw this gem of not so legible code in solib-svr4.c (scan_dyntag):
> 
> 	if (dyn_tag == dyntag)
> 
> and thought it deserved a small rename.

Indeed!

> 2014-08-01  Simon Marchi  <simon.marchi@ericsson.com>
> 
> 	* solib-svr4.c (scan_dyntag): Rename dyntag, dyn_tag and
> 	dyn_ptr variables.

Approved, and many thanks for this small but important improvement.
We also have the same issue in scan_dyntag_auxv; if you feel inclined
to it, the same change is pre-approved there.
  
Simon Marchi Aug. 6, 2014, 7:34 p.m. UTC | #2
On 14-08-06 09:17 AM, Joel Brobecker wrote:
>> I saw this gem of not so legible code in solib-svr4.c (scan_dyntag):
>>
>> 	if (dyn_tag == dyntag)
>>
>> and thought it deserved a small rename.
> 
> Indeed!
> 
>> 2014-08-01  Simon Marchi  <simon.marchi@ericsson.com>
>>
>> 	* solib-svr4.c (scan_dyntag): Rename dyntag, dyn_tag and
>> 	dyn_ptr variables.
> 
> Approved, and many thanks for this small but important improvement.
> We also have the same issue in scan_dyntag_auxv; if you feel inclined
> to it, the same change is pre-approved there.

Thanks Joel.

Pushed with modifications to scan_dyntag_auxv as well.
  
Joel Brobecker Aug. 6, 2014, 7:51 p.m. UTC | #3
> Pushed with modifications to scan_dyntag_auxv as well.

Thanks! Just to follow our procedures when a patch being pushed
is different from the patch already posted, would you mind posting
the patch you pushed here?
  

Patch

diff --git a/gdb/solib-svr4.c b/gdb/solib-svr4.c
index af9d648..d1a6aea 100644
--- a/gdb/solib-svr4.c
+++ b/gdb/solib-svr4.c
@@ -614,14 +614,14 @@  find_program_interpreter (void)
 }
 
 
-/* Scan for DYNTAG in .dynamic section of ABFD.  If DYNTAG is found 1 is
-   returned and the corresponding PTR is set.  */
+/* Scan for DESIRED_DYNTAG in .dynamic section of ABFD.  If DESIRED_DYNTAG is
+   found, 1 is returned and the corresponding PTR is set.  */
 
 static int
-scan_dyntag (int dyntag, bfd *abfd, CORE_ADDR *ptr)
+scan_dyntag (const int desired_dyntag, bfd *abfd, CORE_ADDR *ptr)
 {
   int arch_size, step, sect_size;
-  long dyn_tag;
+  long current_dyntag;
   CORE_ADDR dyn_ptr, dyn_addr;
   gdb_byte *bufend, *bufstart, *buf;
   Elf32_External_Dyn *x_dynp_32;
@@ -679,18 +679,18 @@  scan_dyntag (int dyntag, bfd *abfd, CORE_ADDR *ptr)
     if (arch_size == 32)
       {
 	x_dynp_32 = (Elf32_External_Dyn *) buf;
-	dyn_tag = bfd_h_get_32 (abfd, (bfd_byte *) x_dynp_32->d_tag);
+	current_dyntag = bfd_h_get_32 (abfd, (bfd_byte *) x_dynp_32->d_tag);
 	dyn_ptr = bfd_h_get_32 (abfd, (bfd_byte *) x_dynp_32->d_un.d_ptr);
       }
     else
       {
 	x_dynp_64 = (Elf64_External_Dyn *) buf;
-	dyn_tag = bfd_h_get_64 (abfd, (bfd_byte *) x_dynp_64->d_tag);
+	current_dyntag = bfd_h_get_64 (abfd, (bfd_byte *) x_dynp_64->d_tag);
 	dyn_ptr = bfd_h_get_64 (abfd, (bfd_byte *) x_dynp_64->d_un.d_ptr);
       }
-     if (dyn_tag == DT_NULL)
+     if (current_dyntag == DT_NULL)
        return 0;
-     if (dyn_tag == dyntag)
+     if (current_dyntag == desired_dyntag)
        {
 	 /* If requested, try to read the runtime value of this .dynamic
 	    entry.  */