Move generic_load declaration to symfile.h

Message ID 20190630002107.12982-1-simon.marchi@polymtl.ca
State New
Headers show
Series
  • Move generic_load declaration to symfile.h
Related show

Commit Message

Simon Marchi June 30, 2019, 12:21 a.m.
... since the implementation is in symfile.c.

At the same time, add some documentation and make sure the first
parameter's name in the declaration matches the definition.

gdb/ChangeLog:

	* defs.h (generic_load): Move from here...
	* symfile.h (generic_load): ... to here.  Rename name parameter
	to args.
	* symfile.c (generic_load): Add comment.
---
 gdb/defs.h    | 3 ---
 gdb/symfile.c | 2 ++
 gdb/symfile.h | 6 ++++++
 3 files changed, 8 insertions(+), 3 deletions(-)

-- 
2.22.0

Comments

Tom Tromey July 1, 2019, 1:03 p.m. | #1
>>>>> "Simon" == Simon Marchi <simon.marchi@polymtl.ca> writes:


Simon> ... since the implementation is in symfile.c.
Simon> At the same time, add some documentation and make sure the first
Simon> parameter's name in the declaration matches the definition.

Simon> gdb/ChangeLog:

Simon> 	* defs.h (generic_load): Move from here...
Simon> 	* symfile.h (generic_load): ... to here.  Rename name parameter
Simon> 	to args.
Simon> 	* symfile.c (generic_load): Add comment.

Thanks, this looks good to me.  I'm generally in favor of shrinking
defs.h and of having the .h reflect the .c.

Tom
Simon Marchi July 2, 2019, 2:31 p.m. | #2
On 2019-07-01 9:03 a.m., Tom Tromey wrote:
>>>>>> "Simon" == Simon Marchi <simon.marchi@polymtl.ca> writes:

> 

> Simon> ... since the implementation is in symfile.c.

> Simon> At the same time, add some documentation and make sure the first

> Simon> parameter's name in the declaration matches the definition.

> 

> Simon> gdb/ChangeLog:

> 

> Simon> 	* defs.h (generic_load): Move from here...

> Simon> 	* symfile.h (generic_load): ... to here.  Rename name parameter

> Simon> 	to args.

> Simon> 	* symfile.c (generic_load): Add comment.

> 

> Thanks, this looks good to me.  I'm generally in favor of shrinking

> defs.h and of having the .h reflect the .c.

> 

> Tom

> 


Thanks, I have pushed it.

Simon

Patch

diff --git a/gdb/defs.h b/gdb/defs.h
index 3d878c84e3f1..81ab74c27f5d 100644
--- a/gdb/defs.h
+++ b/gdb/defs.h
@@ -300,9 +300,6 @@  EXTERN_C char *re_comp (const char *);
 
 extern void symbol_file_command (const char *, int);
 
-/* * Remote targets may wish to use this as their load function.  */
-extern void generic_load (const char *name, int from_tty);
-
 /* From top.c */
 
 typedef void initialize_file_ftype (void);
diff --git a/gdb/symfile.c b/gdb/symfile.c
index 6f9c81c8b948..59647bfe9d80 100644
--- a/gdb/symfile.c
+++ b/gdb/symfile.c
@@ -2023,6 +2023,8 @@  static void print_transfer_performance (struct ui_file *stream,
 					unsigned long write_count,
 				        std::chrono::steady_clock::duration d);
 
+/* See symfile.h.  */
+
 void
 generic_load (const char *args, int from_tty)
 {
diff --git a/gdb/symfile.h b/gdb/symfile.h
index daddd2e21abe..403dd165264e 100644
--- a/gdb/symfile.h
+++ b/gdb/symfile.h
@@ -532,6 +532,12 @@  void expand_symtabs_matching
 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
 			   int need_fullname);
 
+/* Target-agnostic function to load the sections of an executable into memory.
+
+   ARGS should be in the form "EXECUTABLE [OFFSET]", where OFFSET is an
+   optional offset to apply to each section.  */
+extern void generic_load (const char *args, int from_tty);
+
 /* From dwarf2read.c */
 
 /* Names for a dwarf2 debugging section.  The field NORMAL is the normal