[Emacs-diffs] /srv/bzr/emacs/emacs-24 r107844: Improve description of :advertised-binding in Lisp manual.

[Chong Yidong]

------------------------------------------------------------
revno: 107844
committer: Chong Yidong <address@hidden>
branch nick: emacs-24
timestamp: Tue 2012-04-17 13:58:34 +0800
message:
  Improve description of :advertised-binding in Lisp manual.
  
  * doc/lispref/keymaps.texi (Menu Bar): Move most of the :advertised-binding
  description to help.texi.
  
  * doc/lispref/help.texi (Keys in Documentation): Mention :advertised-binding.
modified:
  doc/lispref/ChangeLog
  doc/lispref/help.texi
  doc/lispref/keymaps.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-04-16 00:55:06 +0000
+++ b/doc/lispref/ChangeLog     2012-04-17 05:58:34 +0000
@@ -1,3 +1,10 @@
+2012-04-17  Chong Yidong  <address@hidden>
+
+       * help.texi (Keys in Documentation): Mention :advertised-binding.
+
+       * keymaps.texi (Menu Bar): Move most of the :advertised-binding
+       description to help.texi.
+
 2012-04-16  Glenn Morris  <address@hidden>
 
        * processes.texi (Process Information, Input to Processes)

=== modified file 'doc/lispref/help.texi'
--- a/doc/lispref/help.texi     2012-04-10 07:11:23 +0000
+++ b/doc/lispref/help.texi     2012-04-17 05:58:34 +0000
@@ -348,6 +348,21 @@
 replaces them by what they stand for, returning the result as a string.
 This permits display of documentation that refers accurately to the
 user's own customized key bindings.
+
address@hidden advertised binding
+If a command has multiple bindings, this function normally uses the
+first one it finds.  You can specify one particular key binding by
+assigning an @code{:advertised-binding} symbol property to the
+command, like this:
+
address@hidden
+(put 'undo :advertised-binding [?\C-/])
address@hidden smallexample
+
address@hidden
+The @code{:advertised-binding} property also affects the binding shown
+in menu items (@pxref{Menu Bar}).  The property is ignored if it
+specifies a key binding that the command does not actually have.
 @end defun
 
   Here are examples of the special sequences:

=== modified file 'doc/lispref/keymaps.texi'
--- a/doc/lispref/keymaps.texi  2012-04-10 07:34:53 +0000
+++ b/doc/lispref/keymaps.texi  2012-04-17 05:58:34 +0000
@@ -2549,17 +2549,8 @@
 convenient hint for users who do not know the key binding.  If a
 command has multiple bindings, Emacs normally displays the first one
 it finds.  You can specify one particular key binding by assigning an
address@hidden:advertised-binding} symbol property to the command.  For
-instance, the following tells Emacs to show @kbd{C-/} for the
address@hidden menu item:
-
address@hidden
-(put 'undo :advertised-binding [?\C-/])
address@hidden smallexample
-
address@hidden
-If the @code{:advertised-binding} property specifies a key binding
-that the command does not actually have, it is ignored.
address@hidden:advertised-binding} symbol property to the command.  @xref{Keys
+in Documentation}.
 
 @node Tool Bar
 @subsection Tool bars