* fix use of @kbd and @key in gdb.texinfo
@ 2006-10-10 18:56 Bob Wilson
2006-10-10 21:45 ` Eli Zaretskii
0 siblings, 1 reply; 9+ messages in thread
From: Bob Wilson @ 2006-10-10 18:56 UTC (permalink / raw)
To: gdb-patches
[-- Attachment #1: Type: text/plain, Size: 982 bytes --]
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.
[-- Attachment #2: gdb.texinfo.patch --]
[-- Type: text/plain, Size: 4582 bytes --]
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
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: fix use of @kbd and @key in gdb.texinfo 2006-10-10 18:56 fix use of @kbd and @key in gdb.texinfo Bob Wilson @ 2006-10-10 21:45 ` Eli Zaretskii 2006-10-15 21:33 ` [doc/commit] " Eli Zaretskii 2006-10-24 17:52 ` Jim Blandy 0 siblings, 2 replies; 9+ messages in thread From: Eli Zaretskii @ 2006-10-10 21:45 UTC (permalink / raw) To: Bob Wilson; +Cc: gdb-patches > Date: Tue, 10 Oct 2006 11:56:23 -0700 > From: Bob Wilson <bwilson@tensilica.com> > > I've committed this as an obvious patch to fix inconsistent use of the TeXinfo > @kbd and @key macros in the GDB documentation. Thanks, but I'd really prefer that you'd post an RFA first, because some of the changes you did are not obvious at all. Specifically, I don't want to use the Emacs C-c notation in parts of the documentation that are not related to Emacs, because I fear that users who are not familiar with Emacs will not know what C-c means without explanation. (The Emacs manual has a lengthy chapter explaining that, but GDB doesn't.) So please change C-c etc. back to Ctrl-C form, except where Emacs is involved. The changes @kbd<->@key you made are okay, thanks. > * 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. This ChangeLog entry is not according to GNU standards, it should be like this: * 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. i.e., each line that references functions/chapters/sections should be enclosed in parens. ^ permalink raw reply [flat|nested] 9+ messages in thread
* [doc/commit] Re: fix use of @kbd and @key in gdb.texinfo 2006-10-10 21:45 ` Eli Zaretskii @ 2006-10-15 21:33 ` Eli Zaretskii 2006-10-15 21:38 ` Daniel Jacobowitz 2006-10-24 17:52 ` Jim Blandy 1 sibling, 1 reply; 9+ messages in thread From: Eli Zaretskii @ 2006-10-15 21:33 UTC (permalink / raw) To: bwilson, gdb-patches > Date: Tue, 10 Oct 2006 23:45:17 +0200 > From: Eli Zaretskii <eliz@gnu.org> > CC: gdb-patches@sources.redhat.com > > Specifically, I don't want to use the Emacs C-c notation in parts of > the documentation that are not related to Emacs, because I fear that > users who are not familiar with Emacs will not know what C-c means > without explanation. (The Emacs manual has a lengthy chapter > explaining that, but GDB doesn't.) So please change C-c etc. back to > Ctrl-C form, except where Emacs is involved. Fixed this myself as shown below. > > * 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. > > This ChangeLog entry is not according to GNU standards, it should be > like this: Fixed this one as well. 2006-10-15 Eli Zaretskii <eliz@gnu.org> * gdb.texinfo (Sample Session, Invocation, Quitting GDB) (Command Syntax, Signals, Backtrace, Connecting) (Remote configuration, Renesas Boards, Console I/O): Fix last change: use Ctrl- instead of C-, except wrt Emacs. (File-I/O Examples): Put Ctrl-c in @kbd. (Cygwin Native, File-I/O Overview, The Ctrl-C message) (Console I/O): Use @samp with Ctrl-. Index: gdb/doc/gdb.texinfo =================================================================== RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v retrieving revision 1.358 diff -u -r1.358 gdb.texinfo --- gdb/doc/gdb.texinfo 14 Oct 2006 18:34:02 -0000 1.358 +++ gdb/doc/gdb.texinfo 15 Oct 2006 21:16:36 -0000 @@ -537,7 +537,7 @@ @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))} @b{baz} -@b{C-d} +@b{Ctrl-d} m4: End of input: 0: fatal error: EOF in string @end smallexample @@ -754,7 +754,7 @@ lengths. We allow @code{m4} exit by giving it an EOF as input: @smallexample -@b{C-d} +@b{Ctrl-d} Program exited normally. @end smallexample @@ -776,7 +776,7 @@ @item type @samp{@value{GDBP}} to start @value{GDBN}. @item -type @kbd{quit} or @kbd{C-d} to exit. +type @kbd{quit} or @kbd{Ctrl-d} to exit. @end itemize @menu @@ -1277,14 +1277,14 @@ @item quit @r{[}@var{expression}@r{]} @itemx q To exit @value{GDBN}, use the @code{quit} command (abbreviated -@code{q}), or type an end-of-file character (usually @kbd{C-d}). If you +@code{q}), or type an end-of-file character (usually @kbd{Ctrl-d}). If you do not supply @var{expression}, @value{GDBN} will terminate normally; otherwise it will terminate using the result of @var{expression} as the error code. @end table @cindex interrupt -An interrupt (often @kbd{C-c}) does not exit from @value{GDBN}, but rather +An interrupt (often @kbd{Ctrl-c}) does not exit from @value{GDBN}, but rather terminates the action of any @value{GDBN} command that is in progress and returns to @value{GDBN} command level. It is safe to type the interrupt character at any time because @value{GDBN} does not allow it to take effect @@ -1411,8 +1411,8 @@ Files,,Command files}). @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 +@kindex Ctrl-o @r{(operate-and-get-next)} +The @kbd{Ctrl-o} binding is useful for repeating a complex sequence of 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. @@ -4096,7 +4096,7 @@ A signal is an asynchronous event that can happen in a program. The operating system defines the possible kinds of signals, and gives each kind a name and a number. For example, in Unix @code{SIGINT} is the -signal a program gets when you type an interrupt character (often @kbd{C-c}); +signal a program gets when you type an interrupt character (often @kbd{Ctrl-c}); @code{SIGSEGV} is the signal a program gets from referencing a place in memory far away from all the areas in use; @code{SIGALRM} occurs when the alarm clock timer goes off (which happens only if your program has @@ -4455,7 +4455,7 @@ frames in the stack. You can stop the backtrace at any time by typing the system interrupt -character, normally @kbd{C-c}. +character, normally @kbd{Ctrl-c}. @item backtrace @var{n} @itemx bt @var{n} @@ -12473,7 +12473,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 @kbd{C-c}), @value{GDBN} attempts to stop the +interrupt character (often @kbd{Ctrl-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: @@ -12663,7 +12663,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 type @kbd{C-c} to interrupt the program running +when you type @kbd{Ctrl-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. @@ -13617,7 +13617,7 @@ This boolean value controls whether the debuggee should start a new group or stay in the same group as the debugger. This affects the way the Windows OS handles -Ctrl-C. +@samp{Ctrl-C}. @kindex show new-group @item show new-group @@ -14464,7 +14464,7 @@ Use the @sc{reset} button on the development board @itemize @bullet @item -to interrupt your program (don't use @kbd{C-c} on the DOS host---it has +to interrupt your program (don't use @kbd{Ctrl-c} on the DOS host---it has no way to pass an interrupt signal to the development board); and @item @@ -24253,7 +24253,7 @@ the target is stopped to allow deterministic access to the target's memory. Therefore File-I/O is not interruptible by target signals. On the other hand, it is possible to interrupt File-I/O by a user interrupt -(Ctrl-C) within @value{GDBN}. +(@samp{Ctrl-C}) within @value{GDBN}. The target's request to perform a host system call does not finish the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means, @@ -24409,16 +24409,16 @@ @node The Ctrl-C message -@subsection The Ctrl-C message +@subsection The @samp{Ctrl-C} message @cindex ctrl-c message, in file-i/o protocol -If the Ctrl-C flag is set in the @value{GDBN} -reply packet (@pxref{The F reply packet}), +If the @samp{Ctrl-C} flag is set in the @value{GDBN} +reply packet (@pxref{The F reply packet}), the target should behave as if it had gotten a break message. The meaning for the target is ``system call interrupted by @code{SIGINT}''. Consequentially, the target should actually stop (as with a break message) and return to @value{GDBN} with a @code{T02} -packet. +packet. It's important for the target to know in which state the system call was interrupted. There are two possible cases: @@ -24461,7 +24461,7 @@ @itemize @bullet @item -The user types @kbd{C-c}. The behaviour is as explained above, and the +The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the @code{read} system call is treated as finished. @@ -24470,8 +24470,8 @@ newline. @item -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. +The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing +character (neither newline nor @samp{Ctrl-D}) is appended to the input. @end itemize @@ -25350,7 +25350,7 @@ -> @code{F-1,9} @end smallexample -Example sequence of a read call, user presses Ctrl-C before syscall on +Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on host is called: @smallexample @@ -25359,7 +25359,7 @@ <- @code{T02} @end smallexample -Example sequence of a read call, user presses Ctrl-C after syscall on +Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on host is called: @smallexample ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [doc/commit] Re: fix use of @kbd and @key in gdb.texinfo 2006-10-15 21:33 ` [doc/commit] " Eli Zaretskii @ 2006-10-15 21:38 ` Daniel Jacobowitz 2006-10-16 17:55 ` Bob Wilson 0 siblings, 1 reply; 9+ messages in thread From: Daniel Jacobowitz @ 2006-10-15 21:38 UTC (permalink / raw) To: Eli Zaretskii; +Cc: bwilson, gdb-patches On Sun, Oct 15, 2006 at 11:32:58PM +0200, Eli Zaretskii wrote: > > Date: Tue, 10 Oct 2006 23:45:17 +0200 > > From: Eli Zaretskii <eliz@gnu.org> > > CC: gdb-patches@sources.redhat.com > > > > Specifically, I don't want to use the Emacs C-c notation in parts of > > the documentation that are not related to Emacs, because I fear that > > users who are not familiar with Emacs will not know what C-c means > > without explanation. (The Emacs manual has a lengthy chapter > > explaining that, but GDB doesn't.) So please change C-c etc. back to > > Ctrl-C form, except where Emacs is involved. > > Fixed this myself as shown below. Thank you! Bob, please don't do this again; part of the obligation of committing "obvious" changes is being responsive when someone disputes their obviousness. Thanks in advance. -- Daniel Jacobowitz CodeSourcery ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [doc/commit] Re: fix use of @kbd and @key in gdb.texinfo 2006-10-15 21:38 ` Daniel Jacobowitz @ 2006-10-16 17:55 ` Bob Wilson 2006-10-17 19:47 ` Eli Zaretskii 0 siblings, 1 reply; 9+ messages in thread From: Bob Wilson @ 2006-10-16 17:55 UTC (permalink / raw) To: Eli Zaretskii, Daniel Jacobowitz; +Cc: gdb-patches [-- Attachment #1: Type: text/plain, Size: 1883 bytes --] Daniel Jacobowitz wrote: > Bob, please don't do this again; part of the obligation of committing > "obvious" changes is being responsive when someone disputes their > obviousness. Thanks in advance. Somehow the message that Eli sent directly to me did not get through, probably lost in a torrent of spam, and I don't read gdb-patches regularly. That's not a very good excuse, though -- I should have made a point of checking the list in case anyone had issues with my change. I'm sorry. I will err on the side of caution next time I have a patch that seems obvious. Eli, thanks for fixing my ChangeLog entry -- I've been writing them that way for years and no one has pointed it out to me before. I'm glad to hear that you want to keep the "Ctrl-" prefix, since it seems more clear to me, but I had thought that it was more important to be consistent throughout the document. (My change was motivated by someone reviewing the documentation here at Tensilica, who complained about the inconsistency.) I understand what you're saying about using Emacs notation in that section, though. What about the TUI chapter? There are lots of "C-" prefixes in there and it's not tied to Emacs users. Should they all use "Ctrl-"? Also, I noticed that there is a mix of upper- and lowercase for Ctrl key combinations, e.g, "Ctrl-C" vs. "Ctrl-c". Can we make them all the same? I have a slight preference for uppercase, especially because of the "Ctrl-L" case that I mentioned earlier, but that goes against the Emacs-style "C-c" convention where the letter is lowercase. Here is a patch to fix one more place to use "Ctrl-". It was using "C-d" before my change, but it seems like it ought to use "Ctrl-" to be consistent, since it has nothing to do with Emacs. 2006-10-16 Bob Wilson <bob.wilson@acm.org> * gdb.texinfo (ST2000): Use Ctrl- instead of C-. [-- Attachment #2: gdb-ctrl.patch --] [-- Type: text/plain, Size: 658 bytes --] Index: gdb.texinfo =================================================================== RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v retrieving revision 1.360 diff -u -r1.360 gdb.texinfo --- gdb.texinfo 15 Oct 2006 21:36:00 -0000 1.360 +++ gdb.texinfo 16 Oct 2006 16:46:19 -0000 @@ -15264,7 +15264,7 @@ 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} ~ C-d} (Return, followed by tilde and control-D). +@kbd{@key{RET} ~ Ctrl-d} (Return, followed by tilde and control-D). @end table @node Z8000 ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [doc/commit] Re: fix use of @kbd and @key in gdb.texinfo 2006-10-16 17:55 ` Bob Wilson @ 2006-10-17 19:47 ` Eli Zaretskii 2006-10-17 21:18 ` Bob Wilson 0 siblings, 1 reply; 9+ messages in thread From: Eli Zaretskii @ 2006-10-17 19:47 UTC (permalink / raw) To: Bob Wilson; +Cc: gdb-patches > Date: Mon, 16 Oct 2006 10:55:23 -0700 > From: Bob Wilson <bwilson@tensilica.com> > CC: gdb-patches@sources.redhat.com > > Somehow the message that Eli sent directly to me did not get through, probably > lost in a torrent of spam, and I don't read gdb-patches regularly. That's not a > very good excuse, though -- I should have made a point of checking the list in > case anyone had issues with my change. I'm sorry. No sweat. > What about the TUI chapter? There are lots of "C-" prefixes in there and it's > not tied to Emacs users. Should they all use "Ctrl-"? I left "C-" there because the text mentions the corresponding Emacs keybindings. But I'm open to other opinions. > Also, I noticed that there is a mix of upper- and lowercase for Ctrl key > combinations, e.g, "Ctrl-C" vs. "Ctrl-c". Can we make them all the same? The latter should be used in @kbd, the former in @samp. If this is so, it's deliberate: @kbd shows what one types, @samp shows what's displayed on the screen as the result. AFAIK, you always get Ctrl-C (uppercase C) when you interrupt a process. > Here is a patch to fix one more place to use "Ctrl-". It was using "C-d" before > my change, but it seems like it ought to use "Ctrl-" to be consistent, since it > has nothing to do with Emacs. Right, please commit this. Thanks. ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [doc/commit] Re: fix use of @kbd and @key in gdb.texinfo 2006-10-17 19:47 ` Eli Zaretskii @ 2006-10-17 21:18 ` Bob Wilson 0 siblings, 0 replies; 9+ messages in thread From: Bob Wilson @ 2006-10-17 21:18 UTC (permalink / raw) To: Eli Zaretskii; +Cc: gdb-patches Eli Zaretskii wrote: >> What about the TUI chapter? There are lots of "C-" prefixes in there and it's >> not tied to Emacs users. Should they all use "Ctrl-"? > > I left "C-" there because the text mentions the corresponding Emacs > keybindings. But I'm open to other opinions. Sounds good enough. I just wanted to make sure that it was intentional. >> Also, I noticed that there is a mix of upper- and lowercase for Ctrl key >> combinations, e.g, "Ctrl-C" vs. "Ctrl-c". Can we make them all the same? > > The latter should be used in @kbd, the former in @samp. If this is > so, it's deliberate: @kbd shows what one types, @samp shows what's > displayed on the screen as the result. AFAIK, you always get Ctrl-C > (uppercase C) when you interrupt a process. OK. I wasn't aware of that distinction, but it makes sense and it looks to me like the doc is now consistently following that rule. --Bob ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: fix use of @kbd and @key in gdb.texinfo 2006-10-10 21:45 ` Eli Zaretskii 2006-10-15 21:33 ` [doc/commit] " Eli Zaretskii @ 2006-10-24 17:52 ` Jim Blandy 2006-10-25 4:30 ` Eli Zaretskii 1 sibling, 1 reply; 9+ messages in thread From: Jim Blandy @ 2006-10-24 17:52 UTC (permalink / raw) To: Eli Zaretskii; +Cc: Bob Wilson, gdb-patches Eli Zaretskii <eliz@gnu.org> writes: > Specifically, I don't want to use the Emacs C-c notation in parts of > the documentation that are not related to Emacs, because I fear that > users who are not familiar with Emacs will not know what C-c means > without explanation. (The Emacs manual has a lengthy chapter > explaining that, but GDB doesn't.) So please change C-c etc. back to > Ctrl-C form, except where Emacs is involved. [Going through mail backlog] Doesn't the gdb documentation incorporate the readline user documentation? That does include a section on the Emacs notation. I had thought the intention is to use the C- and M- notation across Project GNU, but I can't find a reference for that. We do explain M- in the manual, in the section "Command Completion". We could do the same for C-, and then we could actually use the same notation throughout the manual. ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: fix use of @kbd and @key in gdb.texinfo 2006-10-24 17:52 ` Jim Blandy @ 2006-10-25 4:30 ` Eli Zaretskii 0 siblings, 0 replies; 9+ messages in thread From: Eli Zaretskii @ 2006-10-25 4:30 UTC (permalink / raw) To: Jim Blandy; +Cc: bwilson, gdb-patches > Cc: Bob Wilson <bwilson@tensilica.com>, gdb-patches@sources.redhat.com > From: Jim Blandy <jimb@codesourcery.com> > Date: Tue, 24 Oct 2006 10:52:29 -0700 > > Doesn't the gdb documentation incorporate the readline user > documentation? Yes, it does. > That does include a section on the Emacs notation. Yes, but I still have no reason to believe that anyone who reads the few references to Ctrl-C etc. throughout the rest of the GDB manual is familiar with that notation. > We do explain M- in the manual, in the section "Command Completion". > We could do the same for C-, and then we could actually use the same > notation throughout the manual. Again, there's no way I can be sure that explanation is known to whoever reads about Ctrl-C and Ctrl-D elsewhere in the manual. ^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2006-10-25 4:30 UTC | newest] Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2006-10-10 18:56 fix use of @kbd and @key in gdb.texinfo Bob Wilson 2006-10-10 21:45 ` Eli Zaretskii 2006-10-15 21:33 ` [doc/commit] " Eli Zaretskii 2006-10-15 21:38 ` Daniel Jacobowitz 2006-10-16 17:55 ` Bob Wilson 2006-10-17 19:47 ` Eli Zaretskii 2006-10-17 21:18 ` Bob Wilson 2006-10-24 17:52 ` Jim Blandy 2006-10-25 4:30 ` Eli Zaretskii
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox