Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Bob Wilson <bwilson@tensilica.com>
Cc: gdb-patches@sources.redhat.com
Subject: Re: fix use of @kbd and @key in gdb.texinfo
Date: Tue, 10 Oct 2006 21:45:00 -0000	[thread overview]
Message-ID: <ubqojkfpu.fsf@gnu.org> (raw)
In-Reply-To: <452BECD7.4010402@tensilica.com> (message from Bob Wilson on Tue, 	10 Oct 2006 11:56:23 -0700)

> 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.


  reply	other threads:[~2006-10-10 21:45 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-10-10 18:56 Bob Wilson
2006-10-10 21:45 ` Eli Zaretskii [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ubqojkfpu.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=bwilson@tensilica.com \
    --cc=gdb-patches@sources.redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox