Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Mike Frysinger <vapier@gentoo.org>
To: gdb-patches@sourceware.org
Subject: [PATCH v3] gdb: improve usage strings
Date: Tue, 14 Aug 2012 05:29:00 -0000	[thread overview]
Message-ID: <1344922163-15207-1-git-send-email-vapier@gentoo.org> (raw)
In-Reply-To: <1344704080-24677-1-git-send-email-vapier@gentoo.org>

This adds Usage strings to a bunch of commands, tweaks the grammar in a
few, and improves the help text for the handle command.

Signed-off-by: Mike Frysinger <vapier@gentoo.org>

2012-08-11  Mike Frysinger  <vapier@gentoo.org>

	* infcmd.c (_initialize_infcmd): Update help text for the signal,
	stepi, nexti, finish, next, step, jump, and continue commands.
	* infrun.c (_initialize_infrun): Update help text for the handle
	command.
---
v3
	- tweak "signal" documentation more with feedback from Doug

 gdb/infcmd.c |   29 ++++++++++++++++++++---------
 gdb/infrun.c |    6 ++++++
 2 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/gdb/infcmd.c b/gdb/infcmd.c
index d56503c..cbd8a0a 100644
--- a/gdb/infcmd.c
+++ b/gdb/infcmd.c
@@ -3017,40 +3017,49 @@ The target will wait for another debugger to connect.  Not available for\n\
 all targets."));
 
   c = add_com ("signal", class_run, signal_command, _("\
-Continue program giving it signal specified by the argument.\n\
-An argument of \"0\" means continue program without giving it a signal."));
+Continue program with the specified signal.\n\
+Usage: signal SIGNAL\n\
+The SIGNAL arugment is processed the same as the handle command.\n\
+\n\
+An argument of \"0\" means continue the program without sending it a signal.\n\
+This is useful in cases where the program stopped because of a signal,\n\
+and you want to resume the program while discarding the signal."));
   set_cmd_completer (c, signal_completer);
 
   add_com ("stepi", class_run, stepi_command, _("\
 Step one instruction exactly.\n\
-Argument N means do this N times (or till program stops for another \
+Usage: stepi [N]\n\
+Argument N means step N times (or till program stops for another \
 reason)."));
   add_com_alias ("si", "stepi", class_alias, 0);
 
   add_com ("nexti", class_run, nexti_command, _("\
 Step one instruction, but proceed through subroutine calls.\n\
-Argument N means do this N times (or till program stops for another \
+Usage: nexti [N]\n\
+Argument N means step N times (or till program stops for another \
 reason)."));
   add_com_alias ("ni", "nexti", class_alias, 0);
 
   add_com ("finish", class_run, finish_command, _("\
 Execute until selected stack frame returns.\n\
+Usage: finish\n\
 Upon return, the value returned is printed and put in the value history."));
   add_com_alias ("fin", "finish", class_run, 1);
 
   add_com ("next", class_run, next_command, _("\
 Step program, proceeding through subroutine calls.\n\
-Like the \"step\" command as long as subroutine calls do not happen;\n\
-when they do, the call is treated as one instruction.\n\
-Argument N means do this N times (or till program stops for another \
-reason)."));
+Usage: next [N]\n\
+Unlike \"step\", if the current source line calls a subroutine,\n\
+this command does not enter the subroutine, but instead steps over\n\
+the call, in effect treating it as a single source line.)"));
   add_com_alias ("n", "next", class_run, 1);
   if (xdb_commands)
     add_com_alias ("S", "next", class_run, 1);
 
   add_com ("step", class_run, step_command, _("\
 Step program until it reaches a different source line.\n\
-Argument N means do this N times (or till program stops for another \
+Usage: step [N]\n\
+Argument N means step N times (or till program stops for another \
 reason)."));
   add_com_alias ("s", "step", class_run, 1);
 
@@ -3069,6 +3078,7 @@ Execution will also stop upon exit from the current stack frame."));
 
   c = add_com ("jump", class_run, jump_command, _("\
 Continue program being debugged at specified line or address.\n\
+Usage: jump <location>\n\
 Give as argument either LINENUM or *ADDR, where ADDR is an expression\n\
 for an address to start at."));
   set_cmd_completer (c, location_completer);
@@ -3090,6 +3100,7 @@ This command is a combination of tbreak and jump."));
 
   add_com ("continue", class_run, continue_command, _("\
 Continue program being debugged, after signal or breakpoint.\n\
+Usage: continue [N]\n\
 If proceeding from breakpoint, a number N may be used as an argument,\n\
 which means to set the ignore count of that breakpoint to N - 1 (so that\n\
 the breakpoint won't break until the Nth time it is reached).\n\
diff --git a/gdb/infrun.c b/gdb/infrun.c
index 4f59a92..6663086 100644
--- a/gdb/infrun.c
+++ b/gdb/infrun.c
@@ -7099,12 +7099,17 @@ Specify a signal as argument to print info on that signal only."));
 
   c = add_com ("handle", class_run, handle_command, _("\
 Specify how to handle a signal.\n\
+Usage: handle SIGNAL [ACTIONS]\n\
 Args are signals and actions to apply to those signals.\n\
+If no actions are specified, the current settings for the specified signal\n\
+will be displayed instead.\n\
+\n\
 Symbolic signals (e.g. SIGSEGV) are recommended but numeric signals\n\
 from 1-15 are allowed for compatibility with old versions of GDB.\n\
 Numeric ranges may be specified with the form LOW-HIGH (e.g. 1-5).\n\
 The special arg \"all\" is recognized to mean all signals except those\n\
 used by the debugger, typically SIGTRAP and SIGINT.\n\
+\n\
 Recognized actions include \"stop\", \"nostop\", \"print\", \"noprint\",\n\
 \"pass\", \"nopass\", \"ignore\", or \"noignore\".\n\
 Stop means reenter debugger if this signal happens (implies print).\n\
@@ -7113,6 +7118,7 @@ Pass means let program see this signal; otherwise program doesn't know.\n\
 Ignore is a synonym for nopass and noignore is a synonym for pass.\n\
 Pass and Stop may be combined."));
   set_cmd_completer (c, handle_completer);
+
   if (xdb_commands)
     {
       add_com ("lz", class_info, signals_info, _("\
-- 
1.7.9.7


  parent reply	other threads:[~2012-08-14  5:29 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-08-11 16:55 [PATCH] " Mike Frysinger
2012-08-11 17:16 ` Eli Zaretskii
2012-08-11 17:36   ` Mike Frysinger
2012-08-11 17:52     ` Eli Zaretskii
2012-08-11 18:08       ` Mike Frysinger
2012-08-14 15:08         ` Tom Tromey
2012-08-12  5:06     ` Doug Evans
2012-08-12  5:10       ` Mike Frysinger
2012-08-12 17:35       ` Eli Zaretskii
2012-08-13  2:06 ` [PATCH v2] " Mike Frysinger
2012-08-13 20:29   ` Doug Evans
2012-08-14  5:13     ` Mike Frysinger
2012-08-23 11:11     ` Pedro Alves
2012-08-14  5:29 ` Mike Frysinger [this message]
2012-08-14 17:34   ` [PATCH v3] " Doug Evans
2012-08-14 18:10     ` Eli Zaretskii
2012-08-15  1:58       ` Mike Frysinger
2012-08-15  7:22         ` Regression for gdb.base/help.exp [Re: [PATCH v3] gdb: improve usage strings] Jan Kratochvil
2012-08-15 16:25           ` Mike Frysinger
2012-08-15 16:27             ` Doug Evans
2012-08-20  4:29             ` Sergio Durigan Junior
2012-08-17  3:06           ` Mike Frysinger
2012-08-23 16:26         ` further improve "handle" help string Pedro Alves
2012-08-23 16:44           ` Eli Zaretskii
2012-08-23 17:18           ` Mike Frysinger
2012-08-23 17:38             ` Pedro Alves
2012-08-23 11:11     ` [PATCH v3] gdb: improve usage strings Pedro Alves
2012-08-23 16:45       ` 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=1344922163-15207-1-git-send-email-vapier@gentoo.org \
    --to=vapier@gentoo.org \
    --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