[RFA] Update "func" help text to GNU standards

Message ID 20180605164017.28711-1-tom@tromey.com
State New, archived
Headers

Commit Message

Tom Tromey June 5, 2018, 4:40 p.m. UTC
  In my earlier series to change help text to follow the GNU standards
for metasyntactic variables, I missed one: the "func" command.  This
patch updates its help text.

Tested by the buildbot.

gdb/ChangeLog
2018-06-05  Tom Tromey  <tom@tromey.com>

	* stack.c (_initialize_stack): Update "func" help text.
---
 gdb/ChangeLog | 4 ++++
 gdb/stack.c   | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)
  

Comments

Andrew Burgess June 27, 2018, 6:46 p.m. UTC | #1
* Tom Tromey <tom@tromey.com> [2018-06-05 10:40:17 -0600]:

> In my earlier series to change help text to follow the GNU standards
> for metasyntactic variables, I missed one: the "func" command.  This
> patch updates its help text.
> 
> Tested by the buildbot.
> 
> gdb/ChangeLog
> 2018-06-05  Tom Tromey  <tom@tromey.com>
> 
> 	* stack.c (_initialize_stack): Update "func" help text.

FWIW this looks good to me.

Thanks,
Andrew

> ---
>  gdb/ChangeLog | 4 ++++
>  gdb/stack.c   | 4 ++--
>  2 files changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/gdb/stack.c b/gdb/stack.c
> index 97ebc8bc23f..caa71c1bd4e 100644
> --- a/gdb/stack.c
> +++ b/gdb/stack.c
> @@ -2556,8 +2556,8 @@ on this backtrace."));
>  
>    if (dbx_commands)
>      add_com ("func", class_stack, func_command, _("\
> -Select the stack frame that contains <func>.\n\
> -Usage: func <name>"));
> +Select the stack frame that contains NAME.\n\
> +Usage: func NAME"));
>  
>    add_setshow_enum_cmd ("frame-arguments", class_stack,
>  			print_frame_arguments_choices, &print_frame_arguments,
> -- 
> 2.13.6
>
  
Simon Marchi June 27, 2018, 8:26 p.m. UTC | #2
On 2018-06-27 14:46, Andrew Burgess wrote:
> * Tom Tromey <tom@tromey.com> [2018-06-05 10:40:17 -0600]:
> 
>> In my earlier series to change help text to follow the GNU standards
>> for metasyntactic variables, I missed one: the "func" command.  This
>> patch updates its help text.
>> 
>> Tested by the buildbot.
>> 
>> gdb/ChangeLog
>> 2018-06-05  Tom Tromey  <tom@tromey.com>
>> 
>> 	* stack.c (_initialize_stack): Update "func" help text.
> 
> FWIW this looks good to me.
> 
> Thanks,
> Andrew

LGTM too, thanks!

Simon
  

Patch

diff --git a/gdb/stack.c b/gdb/stack.c
index 97ebc8bc23f..caa71c1bd4e 100644
--- a/gdb/stack.c
+++ b/gdb/stack.c
@@ -2556,8 +2556,8 @@  on this backtrace."));
 
   if (dbx_commands)
     add_com ("func", class_stack, func_command, _("\
-Select the stack frame that contains <func>.\n\
-Usage: func <name>"));
+Select the stack frame that contains NAME.\n\
+Usage: func NAME"));
 
   add_setshow_enum_cmd ("frame-arguments", class_stack,
 			print_frame_arguments_choices, &print_frame_arguments,