From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 4589 invoked by alias); 13 Aug 2012 02:06:06 -0000 Received: (qmail 4580 invoked by uid 22791); 13 Aug 2012 02:06:04 -0000 X-SWARE-Spam-Status: No, hits=-5.6 required=5.0 tests=AWL,BAYES_00,KHOP_RCVD_UNTRUST,KHOP_THREADED,RCVD_IN_DNSWL_HI,RCVD_IN_HOSTKARMA_W,T_RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from smtp.gentoo.org (HELO smtp.gentoo.org) (140.211.166.183) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Mon, 13 Aug 2012 02:05:50 +0000 Received: from localhost.localdomain (localhost [127.0.0.1]) by smtp.gentoo.org (Postfix) with ESMTP id 7C2931B4011 for ; Mon, 13 Aug 2012 02:05:49 +0000 (UTC) From: Mike Frysinger To: gdb-patches@sourceware.org Subject: [PATCH v2] gdb: improve usage strings Date: Mon, 13 Aug 2012 02:06:00 -0000 Message-Id: <1344823549-24684-1-git-send-email-vapier@gentoo.org> In-Reply-To: <1344704080-24677-1-git-send-email-vapier@gentoo.org> References: <1344704080-24677-1-git-send-email-vapier@gentoo.org> X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2012-08/txt/msg00353.txt.bz2 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 2012-08-11 Mike Frysinger * 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. --- v2 - improve "signal" and "next" phrasing gdb/infcmd.c | 25 ++++++++++++++++--------- gdb/infrun.c | 6 ++++++ 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/gdb/infcmd.c b/gdb/infcmd.c index d56503c..78bfc04 100644 --- a/gdb/infcmd.c +++ b/gdb/infcmd.c @@ -3017,40 +3017,45 @@ 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 and simultaneously send it the specified signal.\n\ +Usage: signal SIGNAL\n\ +An argument of \"0\" means continue the program without sending it a 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 +3074,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 \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 +3096,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