Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Tom Tromey <tom@tromey.com>
To: gdb-patches@sourceware.org
Cc: Tom Tromey <tom@tromey.com>
Subject: [RFA v2 11/13] Improve "backtrace" help text
Date: Mon, 14 Aug 2017 03:41:00 -0000	[thread overview]
Message-ID: <20170814034030.20863-12-tom@tromey.com> (raw)
In-Reply-To: <20170814034030.20863-1-tom@tromey.com>

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-08-13  Tom Tromey  <tom@tromey.com>

	* stack.c (_initialize_stack): Remove trailing newlines from help
	text.  Add "Usage" line to "backtrace" help.
---
 gdb/ChangeLog |  5 +++++
 gdb/stack.c   | 13 +++++++------
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 9af53f8..84df331 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,10 @@
 2017-08-13  Tom Tromey  <tom@tromey.com>
 
+	* stack.c (_initialize_stack): Remove trailing newlines from help
+	text.  Add "Usage" line to "backtrace" help.
+
+2017-08-13  Tom Tromey  <tom@tromey.com>
+
 	PR python/16486:
 	* python/py-framefilter.c (py_print_args): Call wrap_hint.
 
diff --git a/gdb/stack.c b/gdb/stack.c
index 94f24b2..20cdd97 100644
--- a/gdb/stack.c
+++ b/gdb/stack.c
@@ -2585,22 +2585,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);
@@ -2618,7 +2619,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,
-- 
2.9.4


  parent reply	other threads:[~2017-08-14  3:41 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-08-14  3:41 [RFA v2 00/13] various frame filter fixes and cleanups Tom Tromey
2017-08-14  3:41 ` [RFA v2 01/13] Rationalize "backtrace" command line parsing Tom Tromey
2017-08-14 15:07   ` Eli Zaretskii
2017-08-14  3:41 ` Tom Tromey [this message]
2017-08-14 13:35   ` [RFA v2 11/13] Improve "backtrace" help text Pedro Alves
2017-08-14 14:34     ` Tom Tromey
2017-08-14 14:36       ` Pedro Alves
2017-08-14 14:38         ` Tom Tromey
2017-08-14  3:41 ` [RFA v2 13/13] Remove verbose code from backtrace command Tom Tromey
2017-08-14 13:35   ` Pedro Alves
2017-08-14  3:41 ` [RFA v2 09/13] Return EXT_LANG_BT_ERROR in one more spot in py-framefilter.c Tom Tromey
2017-08-14  3:41 ` [RFA v2 07/13] Throw a "quit" on a KeyboardException " Tom Tromey
2017-08-14  3:41 ` [RFA v2 02/13] Change backtrace_command_1 calling to use flags Tom Tromey
2017-08-14  3:41 ` [RFA v2 08/13] Move some code later in backtrace_command_1 Tom Tromey
2017-08-14  3:41 ` [RFA v2 12/13] Simplify exception handling in py-framefilter.c Tom Tromey
2017-08-14 13:36   ` Pedro Alves
2017-08-14  3:41 ` [RFA v2 10/13] Call wrap_hint in one more spot " Tom Tromey
2017-08-14  3:41 ` [RFA v2 04/13] Remove EXT_LANG_BT_COMPLETED Tom Tromey
2017-08-14  3:41 ` [RFA v2 03/13] Allow elision of some filtered frames Tom Tromey
2017-08-14 15:10   ` Eli Zaretskii
2017-08-14  3:41 ` [RFA v2 05/13] Avoid manual resource management in py-framefilter.c Tom Tromey
2017-08-14  3:57 ` [RFA v2 06/13] Allow C-c to work in backtrace in more cases Tom Tromey
2017-08-14 13:20 ` [RFA v2 00/13] various frame filter fixes and cleanups Pedro Alves
2017-08-14 13:57   ` Phil Muldoon
2017-08-14 14:30     ` Pedro Alves
2017-08-14 13:38 ` Pedro Alves

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=20170814034030.20863-12-tom@tromey.com \
    --to=tom@tromey.com \
    --cc=gdb-patches@sourceware.org \
    /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