This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: fix use of @kbd and @key in gdb.texinfo
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Bob Wilson <bwilson at tensilica dot com>
- Cc: gdb-patches at sources dot redhat dot com
- Date: Tue, 10 Oct 2006 23:45:17 +0200
- Subject: Re: fix use of @kbd and @key in gdb.texinfo
- References: <452BECD7.4010402@tensilica.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> 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.