This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[RFA 00/12] Small help text tweaks
- From: Tom Tromey <tom at tromey dot com>
- To: gdb-patches at sourceware dot org
- Date: Mon, 30 Apr 2018 08:37:19 -0600
- Subject: [RFA 00/12] Small help text tweaks
I've long understood the GNU style for "metasyntactic variables" --
text that is a placeholder for some value -- to be to write them in
all caps. For example, from "gdb --help":
--core=COREFILE Analyze the core dump COREFILE.
However, while researching for this post, I couldn't actually find
this in the GNU coding standards -- I thought it was there, but the
closest I could find was in the Emacs Lisp manual.
Nevertheless, I'm pressing forward with this series, which fixes a
number of spots in gdb to use this style in the help text for
commands.
I found the commands to change using "apropos <" -- since the most
common alternate style is to wrap a metasyntactic with <>.
Regression tested by the buildbot.
Tom