[2/3] Use GNU style for metasyntactic variables in gdb
Commit Message
I searched for other spots that did not use the GNU style for
metasyntactic syntactic variables. This patch fixes most of the ones
I found in gdb proper. There are a few remaining in MI, but I was
unsure whether those should be touched.
gdb/ChangeLog
2018-09-14 Tom Tromey <tom@tromey.com>
* top.c (new_ui_command): Use GNU style for metasyntactic
variables.
* breakpoint.c (stopat_command): Use GNU style for metasyntactic
variables.
* maint.c (maintenance_translate_address): Remove "<>" around
text.
* interps.c (interpreter_exec_cmd): Use GNU style for
metasyntactic variables.
* nto-procfs.c (nto_procfs_target_info): Use GNU style for
metasyntactic variables.
* tracepoint.c (tfind_range_command): Use GNU style for
metasyntactic variables.
(tfind_outside_command): Likewise.
(_initialize_tracepoint): Likewise.
* remote.c (extended_remote_target::create_inferior): Use GNU
style for metasyntactic variables.
* sparc64-tdep.c (adi_examine_command): Use GNU style for
metasyntactic variables.
(adi_assign_command): Likewise.
gdb/testsuite/ChangeLog
2018-09-14 Tom Tromey <tom@tromey.com>
* gdb.base/new-ui.exp (do_execution_tests): Update.
* gdb.base/dbx.exp (test_breakpoints): Update.
---
gdb/ChangeLog | 22 ++++++++++++++++++++++
gdb/breakpoint.c | 2 +-
gdb/interps.c | 2 +-
gdb/maint.c | 2 +-
gdb/nto-procfs.c | 2 +-
gdb/remote.c | 2 +-
gdb/sparc64-tdep.c | 15 +++++++++------
gdb/testsuite/ChangeLog | 5 +++++
gdb/testsuite/gdb.base/dbx.exp | 2 +-
gdb/testsuite/gdb.base/new-ui.exp | 2 +-
gdb/top.c | 2 +-
gdb/tracepoint.c | 8 ++++----
12 files changed, 48 insertions(+), 18 deletions(-)
Comments
On 2018-09-14 10:55 p.m., Tom Tromey wrote:
> I searched for other spots that did not use the GNU style for
> metasyntactic syntactic variables. This patch fixes most of the ones
> I found in gdb proper. There are a few remaining in MI, but I was
> unsure whether those should be touched.
LGTM.
Out of curiosity, is there a place in the GNU coding standard that explicitly
explains this?
Simon
On 2018-09-14 10:55 p.m., Tom Tromey wrote:
> I searched for other spots that did not use the GNU style for
> metasyntactic syntactic variables. This patch fixes most of the ones
> I found in gdb proper. There are a few remaining in MI, but I was
> unsure whether those should be touched.
About MI, I don't see why it should be different. Do you have specific
examples?
I stumbled on some messages like this:
error (_("-environment-cd: Usage DIRECTORY"));
That looks confusing to me, I would much prefer
error (_("Usage: -environment-cd DIRECTORY"));
Simon
>>>>> "Simon" == Simon Marchi <simark@simark.ca> writes:
Simon> On 2018-09-14 10:55 p.m., Tom Tromey wrote:
>> I searched for other spots that did not use the GNU style for
>> metasyntactic syntactic variables. This patch fixes most of the ones
>> I found in gdb proper. There are a few remaining in MI, but I was
>> unsure whether those should be touched.
Simon> LGTM.
Simon> Out of curiosity, is there a place in the GNU coding standard that explicitly
Simon> explains this?
Well, I thought so. Maybe there was in the past and it was removed?
Or maybe it needs to be added, because it is definitely a GNU
convention. You can see it in the --help of any GNU program. Maybe
this is one of those things that François Pinard was planning to put in
the proposed Gnits manual that we never wrote. I sent a note to
bug-standards.
Anyway I could only find a mention in the Texinfo manual, in the @var
node.
Tom
>>>>> "Simon" == Simon Marchi <simark@simark.ca> writes:
Simon> On 2018-09-14 10:55 p.m., Tom Tromey wrote:
>> I searched for other spots that did not use the GNU style for
>> metasyntactic syntactic variables. This patch fixes most of the ones
>> I found in gdb proper. There are a few remaining in MI, but I was
>> unsure whether those should be touched.
Simon> About MI, I don't see why it should be different. Do you have specific
Simon> examples?
if (argc < 1)
error (_("USAGE: %s <BKPT> [<COMMAND> [<COMMAND>...]]"), command);
But there are several if you search for [<][a-z][a-z-]*[>]
Simon> I stumbled on some messages like this:
Simon> error (_("-environment-cd: Usage DIRECTORY"));
Simon> That looks confusing to me, I would much prefer
Simon> error (_("Usage: -environment-cd DIRECTORY"));
Agreed. Which reminds me that my gdb CLI usage quest is also
incomplete.
Tom
>>>>> "Simon" == Simon Marchi <simark@simark.ca> writes:
Simon> I stumbled on some messages like this:
Simon> error (_("-environment-cd: Usage DIRECTORY"));
Simon> That looks confusing to me, I would much prefer
Simon> error (_("Usage: -environment-cd DIRECTORY"));
I'm sending a patch for MI through the buildbot now.
Tom
@@ -9591,7 +9591,7 @@ stopat_command (const char *arg, int from_tty)
}
if (badInput)
- printf_filtered (_("Usage: stop at <line>\n"));
+ printf_filtered (_("Usage: stop at LINE\n"));
else
break_command_1 (arg, 0, from_tty);
}
@@ -375,7 +375,7 @@ interpreter_exec_cmd (const char *args, int from_tty)
nrules = prules.count ();
if (nrules < 2)
- error (_("usage: interpreter-exec <interpreter> [ <command> ... ]"));
+ error (_("Usage: interpreter-exec INTERPRETER [ COMMAND... ]"));
old_interp = ui_interp->current_interpreter;
@@ -444,7 +444,7 @@ maintenance_translate_address (const char *arg, int from_tty)
while (*p && !isspace (*p)) /* Find end of section name. */
p++;
if (*p == '\000') /* End of command? */
- error (_("Need to specify <section-name> and <address>"));
+ error (_("Need to specify section name and address"));
int arg_len = p - arg;
p = skip_spaces (p + 1);
@@ -143,7 +143,7 @@ class nto_procfs_target_native final : public nto_procfs_target
static const target_info nto_procfs_target_info = {
"procfs",
N_("QNX Neutrino local or remote process"),
- N_("QNX Neutrino process. target procfs <node>")
+ N_("QNX Neutrino process. target procfs NODE")
};
struct nto_procfs_target_procfs final : public nto_procfs_target
@@ -10158,7 +10158,7 @@ Remote replied unexpectedly while setting startup-with-shell: %s"),
if (remote_exec_file[0])
error (_("Remote target does not support \"set remote exec-file\""));
if (!args.empty ())
- error (_("Remote target does not support \"set args\" or run <ARGS>"));
+ error (_("Remote target does not support \"set args\" or run ARGS"));
/* Fall back to "R". */
extended_remote_restart ();
@@ -449,7 +449,7 @@ do_assign (CORE_ADDR start, size_t bcnt, int version)
Command syntax:
- adi (examine|x)/count <addr> */
+ adi (examine|x)[/COUNT] [ADDR] */
static void
adi_examine_command (const char *args, int from_tty)
@@ -473,7 +473,7 @@ adi_examine_command (const char *args, int from_tty)
if (p != 0 && *p != 0)
next_address = parse_and_eval_address (p);
if (!cnt || !next_address)
- error (_("Usage: adi examine|x[/count] <addr>"));
+ error (_("Usage: adi examine|x[/COUNT] [ADDR]"));
do_examine (next_address, cnt);
}
@@ -482,11 +482,14 @@ adi_examine_command (const char *args, int from_tty)
Command syntax:
- adi (assign|a)/count <addr> = <version> */
+ adi (assign|a)[/COUNT] ADDR = VERSION */
static void
adi_assign_command (const char *args, int from_tty)
{
+ static const char *adi_usage
+ = N_("Usage: adi assign|a[/COUNT] ADDR = VERSION");
+
/* make sure program is active and adi is available */
if (!target_has_execution)
error (_("ADI command requires a live process/thread"));
@@ -496,13 +499,13 @@ adi_assign_command (const char *args, int from_tty)
const char *exp = args;
if (exp == 0)
- error_no_arg (_("Usage: adi assign|a[/count] <addr> = <version>"));
+ error_no_arg (_(adi_usage));
char *q = (char *) strchr (exp, '=');
if (q)
*q++ = 0;
else
- error (_("Usage: adi assign|a[/count] <addr> = <version>"));
+ error ("%s", _(adi_usage));
size_t cnt = 1;
const char *p = args;
@@ -516,7 +519,7 @@ adi_assign_command (const char *args, int from_tty)
if (p != 0 && *p != 0)
next_address = parse_and_eval_address (p);
else
- error (_("Usage: adi assign|a[/count] <addr> = <version>"));
+ error ("%s", _(adi_usage));
int version = 0;
if (q != NULL) /* parse version tag */
@@ -234,7 +234,7 @@ proc test_breakpoints { } {
set stop_line [gdb_get_line_number "stop-at-call"]
gdb_test "stop at average.c:$stop_line" "Breakpoint.*at.*: file.*average\.c, line $stop_line.*"
gdb_test "stop in average.c:$stop_line" "Usage: stop in <function . address>"
- gdb_test "stop at main" "Usage: stop at <line>"
+ gdb_test "stop at main" "Usage: stop at LINE"
}
#
@@ -87,7 +87,7 @@ proc_with_prefix do_test {} {
}
gdb_test "new-ui" \
- "usage: new-ui <interpreter> <tty>" \
+ "Usage: new-ui INTERPRETER TTY" \
"new-ui without arguments"
set test "new-ui does not repeat"
@@ -338,7 +338,7 @@ new_ui_command (const char *args, int from_tty)
argc = argv.count ();
if (argc < 2)
- error (_("usage: new-ui <interpreter> <tty>"));
+ error (_("Usage: new-ui INTERPRETER TTY"));
interpreter_name = argv[0];
tty_name = argv[1];
@@ -2427,7 +2427,7 @@ tfind_range_command (const char *args, int from_tty)
if (args == 0 || *args == 0)
{ /* XXX FIXME: what should default behavior be? */
- printf_filtered ("Usage: tfind range <startaddr>,<endaddr>\n");
+ printf_filtered ("Usage: tfind range STARTADDR, ENDADDR\n");
return;
}
@@ -2461,7 +2461,7 @@ tfind_outside_command (const char *args, int from_tty)
if (args == 0 || *args == 0)
{ /* XXX FIXME: what should default behavior be? */
- printf_filtered ("Usage: tfind outside <startaddr>,<endaddr>\n");
+ printf_filtered ("Usage: tfind outside STARTADDR, ENDADDR\n");
return;
}
@@ -4031,12 +4031,12 @@ No argument means forward by one frame; '-' means backward by one frame."),
add_cmd ("outside", class_trace, tfind_outside_command, _("\
Select a trace frame whose PC is outside the given range (exclusive).\n\
-Usage: tfind outside addr1, addr2"),
+Usage: tfind outside ADDR1, ADDR2"),
&tfindlist);
add_cmd ("range", class_trace, tfind_range_command, _("\
Select a trace frame whose PC is in the given range (inclusive).\n\
-Usage: tfind range addr1,addr2"),
+Usage: tfind range ADDR1, ADDR2"),
&tfindlist);
add_cmd ("line", class_trace, tfind_line_command, _("\