diff options
| author | Chong Yidong | 2012-05-30 22:08:58 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-05-30 22:08:58 +0800 |
| commit | 353c87f6ff3c0834e521563f8eefa75c0b10e388 (patch) | |
| tree | 12b43f4dabd1f54c0c3c08fee94b45556e3e0c32 /src/doc.c | |
| parent | 0652336413775df89b051f604278c4e9e5ce2784 (diff) | |
| download | emacs-353c87f6ff3c0834e521563f8eefa75c0b10e388.tar.gz emacs-353c87f6ff3c0834e521563f8eefa75c0b10e388.zip | |
* keymap.c (describe_map_tree): Revert 2011-07-07 change.
* doc.c (Fsubstitute_command_keys): Doc fix.
Fixes: debbugs:1169
Diffstat (limited to 'src/doc.c')
| -rw-r--r-- | src/doc.c | 21 |
1 files changed, 13 insertions, 8 deletions
| @@ -698,18 +698,23 @@ the same file name is found in the `doc-directory'. */) | |||
| 698 | DEFUN ("substitute-command-keys", Fsubstitute_command_keys, | 698 | DEFUN ("substitute-command-keys", Fsubstitute_command_keys, |
| 699 | Ssubstitute_command_keys, 1, 1, 0, | 699 | Ssubstitute_command_keys, 1, 1, 0, |
| 700 | doc: /* Substitute key descriptions for command names in STRING. | 700 | doc: /* Substitute key descriptions for command names in STRING. |
| 701 | Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke | 701 | Each substring of the form \\=\\[COMMAND] is replaced by either a |
| 702 | sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not | 702 | keystroke sequence that invokes COMMAND, or "M-x COMMAND" if COMMAND |
| 703 | on any keys. | 703 | is not on any keys. |
| 704 | Substrings of the form \\=\\{MAPVAR} are replaced by summaries | 704 | |
| 705 | \(made by `describe-bindings') of the value of MAPVAR, taken as a keymap. | 705 | Each substring of the form \\=\\{MAPVAR} is replaced by a summary of |
| 706 | Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR | 706 | the value of MAPVAR as a keymap. This summary is similar to the one |
| 707 | produced by `describe-bindings'. The summary ends in two newlines | ||
| 708 | \(used by the helper function `help-make-xrefs' to find the end of the | ||
| 709 | summary). | ||
| 710 | |||
| 711 | Each substring of the form \\=\\<MAPVAR> specifies the use of MAPVAR | ||
| 707 | as the keymap for future \\=\\[COMMAND] substrings. | 712 | as the keymap for future \\=\\[COMMAND] substrings. |
| 708 | \\=\\= quotes the following character and is discarded; | 713 | \\=\\= quotes the following character and is discarded; |
| 709 | thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. | 714 | thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. |
| 710 | 715 | ||
| 711 | Returns original STRING if no substitutions were made. Otherwise, | 716 | Return the original STRING if no substitutions are made. |
| 712 | a new string, without any text properties, is returned. */) | 717 | Otherwise, return a new string, without any text properties. */) |
| 713 | (Lisp_Object string) | 718 | (Lisp_Object string) |
| 714 | { | 719 | { |
| 715 | char *buf; | 720 | char *buf; |