fix use of @kbd and @key in gdb.texinfo

Bob Wilson bwilson@tensilica.com
Tue Oct 10 18:56:00 GMT 2006


I've committed this as an obvious patch to fix inconsistent use of the TeXinfo 
@kbd and @key macros in the GDB documentation.  There were a few places where 
these macros were used in ways that were inconsistent with the rest of 
gdb.texinfo and also with the guidelines in the TeXinfo documentation.

Specifically, @key is supposed to be used for individual keys, and generally not 
when a modifier key is used as part of another character.  @kbd is used 
otherwise.  The predominant convention for @kbd in gdb.texinfo (and elsewhere) 
is to show Ctrl combations as "C-" followed by a lowercase letter, e.g., as 
"C-c" not "Ctrl-C", "ctl-C", or "C-C".  I did not change "C-L" to "C-l" because 
it wasn't obvious that the uppercase L wasn't intentional to avoid confusion 
with "C-1".

gdb/doc/
	* gdb.texinfo (Command Syntax, Connecting, Remote configuration,
	Renesas Boards, ST2000, TUI Keys, TUI Single Key Mode, TUI Commands,
	Emacs, Console I/O): Fix @key and @kbd usage.



-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: gdb.texinfo.patch
URL: <http://sourceware.org/pipermail/gdb-patches/attachments/20061010/2a2e403e/attachment.ksh>


More information about the Gdb-patches mailing list