[RFA,12/12] Update help text in record.c

Message ID 20180430143731.30007-13-tom@tromey.com
State New
Headers show
Series
  • Small help text tweaks
Related show

Commit Message

Tom Tromey April 30, 2018, 2:37 p.m.
This updates some help text in record.c to conform to GNU standards.
I also added a "Usage" line to "record save".

2018-04-29  Tom Tromey  <tom@tromey.com>

	* record.c (_initialize_record): Update help text.
---
 gdb/ChangeLog | 4 ++++
 gdb/record.c  | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)

-- 
2.13.6

Comments

Pedro Alves May 4, 2018, 6:57 p.m. | #1
On 04/30/2018 03:37 PM, Tom Tromey wrote:

> diff --git a/gdb/record.c b/gdb/record.c

> index d7befb2a74..4ecfc8f418 100644

> --- a/gdb/record.c

> +++ b/gdb/record.c

> @@ -822,8 +822,8 @@ A size of \"unlimited\" means unlimited lines.  The default is 10."),

>  

>    c = add_cmd ("save", class_obscure, cmd_record_save,

>  	       _("Save the execution log to a file.\n\

> -Argument is optional filename.\n\

> -Default filename is 'gdb_record.<process_id>'."),

> +Usage: record save [FILENAME]\n\

> +Default filename is 'gdb_record.PROCESS_ID'."),


Same as in the other patch, about PROCESS_ID not being user
input here.

Otherwise OK.

Thanks,
Pedro Alves

Patch

diff --git a/gdb/record.c b/gdb/record.c
index d7befb2a74..4ecfc8f418 100644
--- a/gdb/record.c
+++ b/gdb/record.c
@@ -822,8 +822,8 @@  A size of \"unlimited\" means unlimited lines.  The default is 10."),
 
   c = add_cmd ("save", class_obscure, cmd_record_save,
 	       _("Save the execution log to a file.\n\
-Argument is optional filename.\n\
-Default filename is 'gdb_record.<process_id>'."),
+Usage: record save [FILENAME]\n\
+Default filename is 'gdb_record.PROCESS_ID'."),
 	       &record_cmdlist);
   set_cmd_completer (c, filename_completer);