unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: emacs-devel@gnu.org
Subject: Re: Doc of keyboard macros
Date: Mon, 24 Sep 2018 12:36:35 -0400	[thread overview]
Message-ID: <jwv4leezx3r.fsf-monnier+gmane.emacs.devel@gnu.org> (raw)
In-Reply-To: 834leec2s2.fsf@gnu.org

>>   . You are breaking the manual's style when describing commands: we
>>     always start with a list of the commands with short descriptions,
>>     and follow that by the detailed descriptions.

Not sure exactly in which way I broke with that convention.
Does it mean that I should move the "details" (like the C-u/C-uC-u and
the F4-vs-C-xe discussion) to after the table?

[ Yes, I admit ashamedly that I'm still not really familiar with
  Emacs's manual's style.  ]

>>   . I don't understand the rationale for removing the "C-u" and
>>     "C-u C-u" sequences from the short list.  What is the purpose of
>>     that?

Because I found it clunky/inconvenient to "repeat" the "@kbd{C-x (} or
@key{F3}" in the form of

    @kbd{C-u C-u C-x (} or @kbd{C-u C-u @key{F3}}

so I preferred to move the C-u/C-uC-u discussion elsewhere.

Now that I think a bit more about it, I actually wonder why we bother
discussing this C-u business so early in the "Basic Keyboard Macro".
I personally never found this of much use: of all the times that I need
to modify the previous macro, the proportion where it can be done by
appending to it seems vanishingly small.

> Oh, and one more nit: there's no need to use the likes of
>
>    @item @kbd{C-x (} or @key{F3}
>
> (which also required you to switch from "@table @kbd" to @asis), you
> could use @itemx instead:
>
>    @item @key{F3}
>    @itemx C-x (

Oh, cool!

So how 'bout the simpler patch below instead,


        Stefan


PS: BTW, I think I figured why I can't easily use F3/F4 (nor F2) on my
systems: I have enabled the "mousekeys" option via setxkbmap (this is
for my old Thinkpad X30 whose mouse buttons don't work any more ;-)
Oddly enough on the machine on which I tried it earlier this results in
those keys doing nothing at all, but on the machine I'm currently using,
they correctly emulate mouse buttons.


diff --git a/doc/emacs/kmacro.texi b/doc/emacs/kmacro.texi
index dac41fdb87..914bb68890 100644
--- a/doc/emacs/kmacro.texi
+++ b/doc/emacs/kmacro.texi
@@ -48,15 +48,19 @@ Basic Keyboard Macro
 @section Basic Use
 
 @table @kbd
+@item C-x (
 @item @key{F3}
 Start defining a keyboard macro
 (@code{kmacro-start-macro-or-insert-counter}).
+@item C-x e
 @item @key{F4}
 If a keyboard macro is being defined, end the definition; otherwise,
 execute the most recent keyboard macro
 (@code{kmacro-end-or-call-macro}).
+@item C-u C-x (
 @item C-u @key{F3}
 Re-execute last keyboard macro, then append keys to its definition.
+@item C-u C-u C-x (
 @item C-u C-u @key{F3}
 Append keys to the last keyboard macro without re-executing it.
 @item C-x C-k r




  reply	other threads:[~2018-09-24 16:36 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-24 14:47 Doc of keyboard macros Stefan Monnier
2018-09-24 15:21 ` Eli Zaretskii
2018-09-24 15:51   ` Eli Zaretskii
2018-09-24 16:36     ` Stefan Monnier [this message]
2018-09-24 16:50       ` Andreas Schwab
2018-09-24 17:07       ` Eli Zaretskii
2018-09-24 19:00         ` Stefan Monnier
2018-09-24 19:23         ` Juri Linkov
2018-09-24 19:35           ` Eli Zaretskii
2018-09-24 20:03             ` Alan Mackenzie
2018-09-24 20:17             ` Joost Kremers
2018-10-10 20:25               ` Mathias Dahl
2018-10-14  8:28                 ` Marcin Borkowski
2018-10-14 14:33                   ` Yuri Khan
2018-10-15 20:22                     ` Juri Linkov
2018-10-16  1:05                       ` Van L
2018-09-24 20:06           ` Drew Adams
2018-09-24 20:22         ` Filipp Gunbin

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=jwv4leezx3r.fsf-monnier+gmane.emacs.devel@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=emacs-devel@gnu.org \
    /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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).