This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[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



Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]