aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChong Yidong2012-12-02 15:13:44 +0800
committerChong Yidong2012-12-02 15:13:44 +0800
commit547d686504dbff205a392aec5a1cf91de310f520 (patch)
tree8f1756541bea17b297f1160c3d12a473b5f46102
parentff3d86d0996d665f9cbb217ca24a63e59b058460 (diff)
downloademacs-547d686504dbff205a392aec5a1cf91de310f520.tar.gz
emacs-547d686504dbff205a392aec5a1cf91de310f520.zip
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
-rw-r--r--doc/emacs/ChangeLog4
-rw-r--r--doc/emacs/custom.texi12
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/keymaps.texi10
-rw-r--r--etc/NEWS12
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 @@
12012-12-02 Chong Yidong <cyd@gnu.org>
2
3 * custom.texi (Init Rebinding): kbd is now a function (Bug#13052).
4
12012-11-18 Dani Moncayo <dmoncayo@gmail.com> 52012-11-18 Dani Moncayo <dmoncayo@gmail.com>
2 6
3 * display.texi (Auto Scrolling): Fix some inaccuracies, plus 7 * 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.
1648 1648
1649@findex kbd 1649@findex kbd
1650 There are several ways to write a key binding using Lisp. The 1650 There are several ways to write a key binding using Lisp. The
1651simplest is to use the @code{kbd} macro, which converts a textual 1651simplest is to use the @code{kbd} function, which converts a textual
1652representation of a key sequence---similar to how we have written key 1652representation of a key sequence---similar to how we have written key
1653sequences in this manual---into a form that can be passed as an 1653sequences in this manual---into a form that can be passed as an
1654argument to @code{global-set-key}. For example, here's how to bind 1654argument to @code{global-set-key}. For example, here's how to bind
@@ -1676,11 +1676,11 @@ and mouse events:
1676(global-set-key (kbd "<mouse-2>") 'mouse-save-then-kill) 1676(global-set-key (kbd "<mouse-2>") 'mouse-save-then-kill)
1677@end example 1677@end example
1678 1678
1679 Instead of using the @code{kbd} macro, you can use a Lisp string or 1679 Instead of using @code{kbd}, you can use a Lisp string or vector to
1680vector to specify the key sequence. Using a string is simpler, but 1680specify the key sequence. Using a string is simpler, but only works
1681only works for @acronym{ASCII} characters and Meta-modified 1681for @acronym{ASCII} characters and Meta-modified @acronym{ASCII}
1682@acronym{ASCII} characters. For example, here's how to bind @kbd{C-x 1682characters. For example, here's how to bind @kbd{C-x M-l} to
1683M-l} to @code{make-symbolic-link} (@pxref{Misc File Ops}): 1683@code{make-symbolic-link} (@pxref{Misc File Ops}):
1684 1684
1685@example 1685@example
1686(global-set-key "\C-x\M-l" 'make-symbolic-link) 1686(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 @@
12012-12-02 Chong Yidong <cyd@gnu.org>
2
3 * keymaps.texi (Key Sequences): kbd is now a function.
4
12012-11-23 Martin Rudalics <rudalics@gmx.at> 52012-11-23 Martin Rudalics <rudalics@gmx.at>
2 6
3 * windows.texi (Basic Windows): Fix typo. 7 * 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}.
75 For examples of key sequences written in string and vector 75 For examples of key sequences written in string and vector
76representations, @ref{Init Rebinding,,, emacs, The GNU Emacs Manual}. 76representations, @ref{Init Rebinding,,, emacs, The GNU Emacs Manual}.
77 77
78@defmac kbd keyseq-text 78@defun kbd keyseq-text
79This macro converts the text @var{keyseq-text} (a string constant) 79This function converts the text @var{keyseq-text} (a string constant)
80into a key sequence (a string or vector constant). The contents of 80into a key sequence (a string or vector constant). The contents of
81@var{keyseq-text} should use the same syntax as in the buffer invoked 81@var{keyseq-text} should use the same syntax as in the buffer invoked
82by the @kbd{C-x C-k @key{RET}} (@code{kmacro-edit-macro}) command; in 82by the @kbd{C-x C-k @key{RET}} (@code{kmacro-edit-macro}) command; in
@@ -97,7 +97,7 @@ Manual}.
97 97
98This macro is not meant for use with arguments that vary---only 98This macro is not meant for use with arguments that vary---only
99with string constants. 99with string constants.
100@end defmac 100@end defun
101 101
102@node Keymap Basics 102@node Keymap Basics
103@section Keymap Basics 103@section Keymap Basics
@@ -1294,8 +1294,8 @@ numeric codes for the modifier bits don't appear in compiled files.
1294 The functions below signal an error if @var{keymap} is not a keymap, 1294 The functions below signal an error if @var{keymap} is not a keymap,
1295or if @var{key} is not a string or vector representing a key sequence. 1295or if @var{key} is not a string or vector representing a key sequence.
1296You can use event types (symbols) as shorthand for events that are 1296You can use event types (symbols) as shorthand for events that are
1297lists. The @code{kbd} macro (@pxref{Key Sequences}) is a convenient 1297lists. The @code{kbd} function (@pxref{Key Sequences}) is a
1298way to specify the key sequence. 1298convenient way to specify the key sequence.
1299 1299
1300@defun define-key keymap key binding 1300@defun define-key keymap key binding
1301This function sets the binding for @var{key} in @var{keymap}. (If 1301This 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
709 709
710+++ 710+++
711** The return values of `defalias', `defun' and `defmacro' have changed, 711** The return values of `defalias', `defun' and `defmacro' have changed,
712and are now undefined. For backwards compatibility, defun and 712and are now undefined. For backwards compatibility, `defun' and
713defmacro currently return the name of the newly defined function/macro 713`defmacro' currently return the name of the newly defined
714but this should not be relied upon. 714function/macro, but this should not be relied upon.
715 715
716--- 716---
717** `face-spec-set' no longer sets frame-specific attributes when the 717** `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).
958+++ 958+++
959** New macros `setq-local' and `defvar-local'. 959** New macros `setq-local' and `defvar-local'.
960 960
961** Changes to special forms and macros
962+++
963*** `defun' and `defmacro' are now macros rather than special forms
964+++
965*** `kbd' is now a function rather than a macro.
966
961+++ 967+++
962** New fringe bitmap `exclamation-mark'. 968** New fringe bitmap `exclamation-mark'.
963 969