public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Tom Tromey <tom@tromey.com>
To: Pedro Alves <palves@redhat.com>
Cc: Tom Tromey <tom@tromey.com>,  gdb-patches@sourceware.org
Subject: Re: [RFA 01/10] Rationalize "backtrace" command line parsing
Date: Sun, 09 Jul 2017 22:34:00 -0000	[thread overview]
Message-ID: <87shi5me8i.fsf@tromey.com> (raw)
In-Reply-To: <9cfa324d-f685-405f-92be-f74846da4e91@redhat.com> (Pedro Alves's	message of "Tue, 27 Jun 2017 17:24:57 +0100")

>>>>> "Pedro" == Pedro Alves <palves@redhat.com> writes:

Pedro> It might be good to clarify "help bt", to show something around:
Pedro>   Usage: backtrace [QUALIFIERS]... COUNT

How about the appended?

Tom

commit 46ab61faf8412739124639aac528d2b7df387632
Author: Tom Tromey <tom@tromey.com>
Date:   Sun Jul 9 16:31:11 2017 -0600

    Improve "backtrace" help text
    
    This improves help text in stack.c in two ways.  First, it removes
    trailing newlines from various help strings.  I think these are never
    needed.  Second, it adds a "Usage" line to the "backtrace" text, as
    suggested by Pedro.
    
    ChangeLog
    2017-07-09  Tom Tromey  <tom@tromey.com>
    
            * stack.c (_initialize_stack): Remove trailing newlines from help
            text.  Add "Usage" line to "backtrace" help.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 210bebc..73b463e 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@
+2017-07-09  Tom Tromey  <tom@tromey.com>
+
+	* stack.c (_initialize_stack): Remove trailing newlines from help
+	text.  Add "Usage" line to "backtrace" help.
+
 2017-04-25  Tom Tromey  <tom@tromey.com>
 
 	PR python/16486:
diff --git a/gdb/stack.c b/gdb/stack.c
index 4f6b117..5df25c4 100644
--- a/gdb/stack.c
+++ b/gdb/stack.c
@@ -2589,22 +2589,23 @@ This is useful in command scripts."));
 Select and print a stack frame.\nWith no argument, \
 print the selected stack frame.  (See also \"info frame\").\n\
 An argument specifies the frame to select.\n\
-It can be a stack frame number or the address of the frame.\n"));
+It can be a stack frame number or the address of the frame."));
 
   add_com_alias ("f", "frame", class_stack, 1);
 
   add_com_suppress_notification ("select-frame", class_stack, select_frame_command, _("\
 Select a stack frame without printing anything.\n\
 An argument specifies the frame to select.\n\
-It can be a stack frame number or the address of the frame.\n"),
+It can be a stack frame number or the address of the frame."),
 		 &cli_suppress_notification.user_selected_context);
 
   add_com ("backtrace", class_stack, backtrace_command, _("\
 Print backtrace of all stack frames, or innermost COUNT frames.\n\
-With a negative argument, print outermost -COUNT frames.\nUse of the \
-'full' qualifier also prints the values of the local variables.\n\
+Usage: backtrace [QUALIFIERS]... [COUNT]\n\
+With a negative argument, print outermost -COUNT frames.\n\
+Use of the 'full' qualifier also prints the values of the local variables.\n\
 Use of the 'no-filters' qualifier prohibits frame filters from executing\n\
-on this backtrace.\n"));
+on this backtrace."));
   add_com_alias ("bt", "backtrace", class_stack, 0);
 
   add_com_alias ("where", "backtrace", class_alias, 0);
@@ -2622,7 +2623,7 @@ on this backtrace.\n"));
   if (dbx_commands)
     add_com ("func", class_stack, func_command, _("\
 Select the stack frame that contains <func>.\n\
-Usage: func <name>\n"));
+Usage: func <name>"));
 
   add_setshow_enum_cmd ("frame-arguments", class_stack,
 			print_frame_arguments_choices, &print_frame_arguments,

  reply	other threads:[~2017-07-09 22:34 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-25 19:41 [RFA 00/10] various frame filter fixes and cleanups Tom Tromey
2017-04-25 19:41 ` [RFA 06/10] Allow C-c to work in backtrace in more cases Tom Tromey
2017-04-28 14:55   ` Phil Muldoon
2017-06-27 16:46   ` Pedro Alves
2017-04-25 19:41 ` [RFA 04/10] Remove EXT_LANG_BT_COMPLETED Tom Tromey
2017-04-28 14:52   ` Phil Muldoon
2017-06-27 16:40     ` Pedro Alves
2017-04-25 19:41 ` [RFA 01/10] Rationalize "backtrace" command line parsing Tom Tromey
2017-04-26 10:33   ` Eli Zaretskii
2017-06-27 16:25   ` Pedro Alves
2017-07-09 22:34     ` Tom Tromey [this message]
2017-07-10 16:48       ` Eli Zaretskii
2017-07-14 12:08       ` Pedro Alves
2017-04-25 19:42 ` [RFA 03/10] Allow elision of some filtered frames Tom Tromey
2017-04-26 10:35   ` Eli Zaretskii
2017-04-28 14:50   ` Phil Muldoon
2017-06-27 16:40   ` Pedro Alves
2017-06-27 20:01     ` Tom Tromey
2017-04-25 19:42 ` [RFA 05/10] Avoid manual resource management in py-framefilter.c Tom Tromey
2017-04-28 14:53   ` Phil Muldoon
2017-06-27 16:43   ` Pedro Alves
2017-04-25 19:42 ` [RFA 07/10] Throw a "quit" on a KeyboardException " Tom Tromey
2017-04-28 15:06   ` Phil Muldoon
2017-06-27 16:59   ` Pedro Alves
2017-04-25 19:42 ` [RFA 09/10] Return EXT_LANG_BT_ERROR in one more spot " Tom Tromey
2017-04-28 15:08   ` Phil Muldoon
2017-06-27 17:31   ` Pedro Alves
2017-06-27 19:08     ` Pedro Alves
2017-04-25 19:42 ` [RFA 10/10] Call wrap_hint " Tom Tromey
2017-04-28 15:09   ` Phil Muldoon
2017-06-27 17:35     ` Pedro Alves
2017-04-25 19:43 ` [RFA 08/10] Move some code later in backtrace_command_1 Tom Tromey
2017-04-28 15:08   ` Phil Muldoon
2017-06-27 17:18   ` Pedro Alves
2017-04-25 19:43 ` [RFA 02/10] Change backtrace_command_1 calling to use flags Tom Tromey
2017-04-28 14:40   ` Phil Muldoon
2017-06-27 16:29   ` Pedro Alves
2017-07-09 22:22     ` Tom Tromey
2017-07-14 12:02       ` Pedro Alves
2017-07-14 19:16         ` Tom Tromey
2017-04-27  8:58 ` [RFA 00/10] various frame filter fixes and cleanups Phil Muldoon
2017-05-29 17:21 ` Tom Tromey

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87shi5me8i.fsf@tromey.com \
    --to=tom@tromey.com \
    --cc=gdb-patches@sourceware.org \
    --cc=palves@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).