From 547d686504dbff205a392aec5a1cf91de310f520 Mon Sep 17 00:00:00 2001 From: Chong Yidong Date: Sun, 2 Dec 2012 15:13:44 +0800 Subject: [PATCH] Document the conversion of kbd into a function. * doc/emacs/custom.texi (Init Rebinding): kbd is now a function. * doc/lispref/keymaps.texi (Key Sequences): kbd is now a function. Fixes: debbugs:13052 --- doc/emacs/ChangeLog | 4 ++++ doc/emacs/custom.texi | 12 ++++++------ doc/lispref/ChangeLog | 4 ++++ doc/lispref/keymaps.texi | 10 +++++----- etc/NEWS | 12 +++++++++--- 5 files changed, 28 insertions(+), 14 deletions(-) diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 56001d6e29e..da38eea8848 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,7 @@ +2012-12-02 Chong Yidong + + * custom.texi (Init Rebinding): kbd is now a function (Bug#13052). + 2012-11-18 Dani Moncayo * display.texi (Auto Scrolling): Fix some inaccuracies, plus diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index a614126dbc0..6ea1ad5535f 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi @@ -1648,7 +1648,7 @@ you can specify them in your initialization file by writing Lisp code. @findex kbd There are several ways to write a key binding using Lisp. The -simplest is to use the @code{kbd} macro, which converts a textual +simplest is to use the @code{kbd} function, which converts a textual representation of a key sequence---similar to how we have written key sequences in this manual---into a form that can be passed as an argument to @code{global-set-key}. For example, here's how to bind @@ -1676,11 +1676,11 @@ and mouse events: (global-set-key (kbd "") 'mouse-save-then-kill) @end example - Instead of using the @code{kbd} macro, you can use a Lisp string or -vector to specify the key sequence. Using a string is simpler, but -only works for @acronym{ASCII} characters and Meta-modified -@acronym{ASCII} characters. For example, here's how to bind @kbd{C-x -M-l} to @code{make-symbolic-link} (@pxref{Misc File Ops}): + Instead of using @code{kbd}, you can use a Lisp string or vector to +specify the key sequence. Using a string is simpler, but only works +for @acronym{ASCII} characters and Meta-modified @acronym{ASCII} +characters. For example, here's how to bind @kbd{C-x M-l} to +@code{make-symbolic-link} (@pxref{Misc File Ops}): @example (global-set-key "\C-x\M-l" 'make-symbolic-link) diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index adb52dc7f2b..b55ded918bb 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,7 @@ +2012-12-02 Chong Yidong + + * keymaps.texi (Key Sequences): kbd is now a function. + 2012-11-23 Martin Rudalics * windows.texi (Basic Windows): Fix typo. diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index d01ecba4bed..d9eddcee669 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -75,8 +75,8 @@ the vector @code{[?\C-x ?l]} represents the key sequence @kbd{C-x l}. For examples of key sequences written in string and vector representations, @ref{Init Rebinding,,, emacs, The GNU Emacs Manual}. -@defmac kbd keyseq-text -This macro converts the text @var{keyseq-text} (a string constant) +@defun kbd keyseq-text +This function converts the text @var{keyseq-text} (a string constant) into a key sequence (a string or vector constant). The contents of @var{keyseq-text} should use the same syntax as in the buffer invoked by the @kbd{C-x C-k @key{RET}} (@code{kmacro-edit-macro}) command; in @@ -97,7 +97,7 @@ Manual}. This macro is not meant for use with arguments that vary---only with string constants. -@end defmac +@end defun @node Keymap Basics @section Keymap Basics @@ -1294,8 +1294,8 @@ numeric codes for the modifier bits don't appear in compiled files. The functions below signal an error if @var{keymap} is not a keymap, or if @var{key} is not a string or vector representing a key sequence. You can use event types (symbols) as shorthand for events that are -lists. The @code{kbd} macro (@pxref{Key Sequences}) is a convenient -way to specify the key sequence. +lists. The @code{kbd} function (@pxref{Key Sequences}) is a +convenient way to specify the key sequence. @defun define-key keymap key binding This function sets the binding for @var{key} in @var{keymap}. (If diff --git a/etc/NEWS b/etc/NEWS index d9efc57b907..a16bdcfd44a 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -709,9 +709,9 @@ The function `user-variable-p' is now an obsolete alias for +++ ** The return values of `defalias', `defun' and `defmacro' have changed, -and are now undefined. For backwards compatibility, defun and -defmacro currently return the name of the newly defined function/macro -but this should not be relied upon. +and are now undefined. For backwards compatibility, `defun' and +`defmacro' currently return the name of the newly defined +function/macro, but this should not be relied upon. --- ** `face-spec-set' no longer sets frame-specific attributes when the @@ -958,6 +958,12 @@ takes precedence over most other maps for a short while (normally one key). +++ ** New macros `setq-local' and `defvar-local'. +** Changes to special forms and macros ++++ +*** `defun' and `defmacro' are now macros rather than special forms ++++ +*** `kbd' is now a function rather than a macro. + +++ ** New fringe bitmap `exclamation-mark'. -- 2.11.4.GIT