From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6889 invoked by alias); 10 Oct 2006 18:56:36 -0000 Received: (qmail 6881 invoked by uid 22791); 10 Oct 2006 18:56:35 -0000 X-Spam-Check-By: sourceware.org Received: from hq.tensilica.com (HELO mailapp.tensilica.com) (65.205.227.29) by sourceware.org (qpsmtpd/0.31) with ESMTP; Tue, 10 Oct 2006 18:56:28 +0000 Received: from localhost ([127.0.0.1] ident=amavis) by mailapp.tensilica.com with esmtp (Exim 4.34) id 1GXMm8-0004ZQ-Sb for gdb-patches@sources.redhat.com; Tue, 10 Oct 2006 11:56:25 -0700 Received: from mailapp.tensilica.com ([127.0.0.1]) by localhost (mailapp [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 16219-03 for ; Tue, 10 Oct 2006 11:56:24 -0700 (PDT) Received: from heron.hq.tensilica.com ([192.168.11.123]) by mailapp.tensilica.com with esmtp (Exim 4.34) id 1GXMm7-0004Z2-W1 for gdb-patches@sources.redhat.com; Tue, 10 Oct 2006 11:56:24 -0700 Received: from [192.168.11.123] (heron.hq.tensilica.com [192.168.11.123]) by heron.hq.tensilica.com (Postfix) with ESMTP id EEB9DAC257 for ; Tue, 10 Oct 2006 11:56:23 -0700 (PDT) Message-ID: <452BECD7.4010402@tensilica.com> Date: Tue, 10 Oct 2006 18:56:00 -0000 From: Bob Wilson User-Agent: Thunderbird 1.5.0.7 (X11/20060922) MIME-Version: 1.0 To: gdb-patches@sources.redhat.com Subject: fix use of @kbd and @key in gdb.texinfo Content-Type: multipart/mixed; boundary="------------000608070609050206000702" Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2006-10/txt/msg00094.txt.bz2 This is a multi-part message in MIME format. --------------000608070609050206000702 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Content-length: 982 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. --------------000608070609050206000702 Content-Type: text/plain; name="gdb.texinfo.patch" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="gdb.texinfo.patch" Content-length: 4582 Index: gdb.texinfo =================================================================== RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v retrieving revision 1.355 diff -u -r1.355 gdb.texinfo --- gdb.texinfo 21 Sep 2006 14:01:12 -0000 1.355 +++ gdb.texinfo 10 Oct 2006 17:45:50 -0000 @@ -1413,7 +1413,7 @@ @cindex repeating command sequences @kindex C-o @r{(operate-and-get-next)} The @kbd{C-o} binding is useful for repeating a complex sequence of -commands. This command accepts the current line, like @kbd{RET}, and +commands. This command accepts the current line, like @key{RET}, and then fetches the next line relative to the current line from the history for editing. @@ -12470,7 +12470,7 @@ @cindex interrupting remote programs @cindex remote programs, interrupting Whenever @value{GDBN} is waiting for the remote program, if you type the -interrupt character (often @key{C-C}), @value{GDBN} attempts to stop the +interrupt character (often @kbd{C-c}), @value{GDBN} attempts to stop the program. This may or may not succeed, depending in part on the hardware and the serial drivers the remote system uses. If you type the interrupt character once again, @value{GDBN} displays this prompt: @@ -12660,7 +12660,7 @@ @cindex BREAK signal instead of Ctrl-C @anchor{set remotebreak} If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote -when you press the @key{Ctrl-C} key to interrupt the program running +when you type @kbd{C-c} to interrupt the program running on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C} character instead. The default is off, since most remote systems expect to see @samp{Ctrl-C} as the interrupt signal. @@ -14461,7 +14461,7 @@ Use the @sc{reset} button on the development board @itemize @bullet @item -to interrupt your program (don't use @kbd{ctl-C} on the DOS host---it has +to interrupt your program (don't use @kbd{C-c} on the DOS host---it has no way to pass an interrupt signal to the development board); and @item @@ -15254,8 +15254,8 @@ Connect the controlling terminal to the STDBUG command monitor. When you are done interacting with STDBUG, typing either of two character sequences gets you back to the @value{GDBN} command prompt: -@kbd{@key{RET}~.} (Return, followed by tilde and period) or -@kbd{@key{RET}~@key{C-d}} (Return, followed by tilde and control-D). +@kbd{@key{RET} ~ .} (Return, followed by tilde and period) or +@kbd{@key{RET} ~ C-d} (Return, followed by tilde and control-D). @end table @node Z8000 @@ -16934,7 +16934,7 @@ for scrolling. This means they are available for readline when the active window is the command window. When the command window does not have the focus, it is necessary to use other readline -key bindings such as @key{C-p}, @key{C-n}, @key{C-b} and @key{C-f}. +key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b} and @kbd{C-f}. @node TUI Single Key Mode @section TUI Single Key Mode @@ -16992,7 +16992,7 @@ it is possible to type most @value{GDBN} commands without interaction with the TUI @emph{SingleKey} mode. Once the command is entered the TUI @emph{SingleKey} mode is restored. The only way to permanently leave -this mode is by hitting @key{q} or @samp{@key{C-x} @key{s}}. +this mode is by typing @kbd{q} or @kbd{C-x s}. @node TUI Commands @@ -17037,7 +17037,7 @@ @item refresh @kindex refresh -Refresh the screen. This is similar to using @key{C-L} key. +Refresh the screen. This is similar to typing @kbd{C-L}. @item tui reg float @kindex tui reg @@ -17241,7 +17241,7 @@ @value{GDBN} @code{down} command. @end table -In any source file, the Emacs command @kbd{C-x SPC} (@code{gud-break}) +In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break}) tells @value{GDBN} to set a breakpoint on the source line point is on. If you type @kbd{M-x speedbar}, then Emacs displays a separate frame which @@ -24458,16 +24458,16 @@ @itemize @bullet @item -The user presses @kbd{Ctrl-C}. The behaviour is as explained above, and the +The user types @kbd{C-c}. The behaviour is as explained above, and the @code{read} system call is treated as finished. @item -The user presses @kbd{Enter}. This is treated as end of input with a trailing +The user presses @key{RET}. This is treated as end of input with a trailing newline. @item -The user presses @kbd{Ctrl-D}. This is treated as end of input. No trailing +The user types @kbd{C-d}. This is treated as end of input. No trailing character (neither newline nor Ctrl-D) is appended to the input. @end itemize --------------000608070609050206000702--