diff mbox

Improve load command's help text

Message ID 1483720888-6467-1-git-send-email-lgustavo@codesourcery.com
State New
Headers show

Commit Message

Luis Machado Jan. 6, 2017, 4:41 p.m. UTC
This fairly obvious patch adds usage text to the load command's help text.

Originally it did not have usage and mentioned things like FILE and OFFSET
without explaining how those should be passed in the command.

gdb/ChangeLog:

2017-01-05  Luis Machado  <lgustavo@codesourcery.com>

	* symfile (_initialize_symfile): Add usage text to the load command's
	help text.
---
 gdb/symfile.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Simon Marchi Jan. 6, 2017, 6:29 p.m. UTC | #1
On 2017-01-06 11:41, Luis Machado wrote:
> diff --git a/gdb/symfile.c b/gdb/symfile.c
> index 61b9e5b..0af1900 100644
> --- a/gdb/symfile.c
> +++ b/gdb/symfile.c
> @@ -3952,7 +3952,8 @@ that lies within the boundaries of this symbol
> file in memory."),
>    c = add_cmd ("load", class_files, load_command, _("\
>  Dynamically load FILE into the running program, and record its 
> symbols\n\
>  for access from GDB.\n\
> -A load OFFSET may also be given."), &cmdlist);
> +A load offset may also be given.\n\
> +Usage: load [FILE] [offset expression]"), &cmdlist);

For consistency, I think this would look better:

   Usage: load [FILE] [OFFSET]

The fact that offset can be an expression can be specified in the text 
just before.
Luis Machado Jan. 6, 2017, 6:30 p.m. UTC | #2
On 01/06/2017 12:29 PM, Simon Marchi wrote:
> On 2017-01-06 11:41, Luis Machado wrote:
>> diff --git a/gdb/symfile.c b/gdb/symfile.c
>> index 61b9e5b..0af1900 100644
>> --- a/gdb/symfile.c
>> +++ b/gdb/symfile.c
>> @@ -3952,7 +3952,8 @@ that lies within the boundaries of this symbol
>> file in memory."),
>>    c = add_cmd ("load", class_files, load_command, _("\
>>  Dynamically load FILE into the running program, and record its
>> symbols\n\
>>  for access from GDB.\n\
>> -A load OFFSET may also be given."), &cmdlist);
>> +A load offset may also be given.\n\
>> +Usage: load [FILE] [offset expression]"), &cmdlist);
>
> For consistency, I think this would look better:
>
>   Usage: load [FILE] [OFFSET]
>
> The fact that offset can be an expression can be specified in the text
> just before.

That sounds good to me.

Thanks,
Luis
Yao Qi Jan. 10, 2017, 2:58 p.m. UTC | #3
On 17-01-06 10:41:28, Luis Machado wrote:
> This fairly obvious patch adds usage text to the load command's help text.
> 
> Originally it did not have usage and mentioned things like FILE and OFFSET
> without explaining how those should be passed in the command.
> 
> gdb/ChangeLog:
> 
> 2017-01-05  Luis Machado  <lgustavo@codesourcery.com>
> 
> 	* symfile (_initialize_symfile): Add usage text to the load command's
> 	help text.

Patch is good to me, with Simon's suggestion.
diff mbox

Patch

diff --git a/gdb/symfile.c b/gdb/symfile.c
index 61b9e5b..0af1900 100644
--- a/gdb/symfile.c
+++ b/gdb/symfile.c
@@ -3952,7 +3952,8 @@  that lies within the boundaries of this symbol file in memory."),
   c = add_cmd ("load", class_files, load_command, _("\
 Dynamically load FILE into the running program, and record its symbols\n\
 for access from GDB.\n\
-A load OFFSET may also be given."), &cmdlist);
+A load offset may also be given.\n\
+Usage: load [FILE] [offset expression]"), &cmdlist);
   set_cmd_completer (c, filename_completer);
 
   add_prefix_cmd ("overlay", class_support, overlay_command,