diff options
| author | Chong Yidong | 2012-05-31 14:08:06 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-05-31 14:08:06 +0800 |
| commit | efc00ab16e2890b75d7224434ac43fe944ade4dd (patch) | |
| tree | 28c1078ca32b96402cd1a5f618a17b3526143f27 /src/doc.c | |
| parent | ba93a18774352c97d6dd73c73141cbff6305581b (diff) | |
| parent | dd41169b6cb0105b0766f3d368c657ebafc19cba (diff) | |
| download | emacs-efc00ab16e2890b75d7224434ac43fe944ade4dd.tar.gz emacs-efc00ab16e2890b75d7224434ac43fe944ade4dd.zip | |
Merge from emacs-24; up to 2012-04-24T21:47:24Z!michael.albinus@gmx.de
Diffstat (limited to 'src/doc.c')
| -rw-r--r-- | src/doc.c | 21 |
1 files changed, 13 insertions, 8 deletions
| @@ -705,18 +705,23 @@ the same file name is found in the `doc-directory'. */) | |||
| 705 | DEFUN ("substitute-command-keys", Fsubstitute_command_keys, | 705 | DEFUN ("substitute-command-keys", Fsubstitute_command_keys, |
| 706 | Ssubstitute_command_keys, 1, 1, 0, | 706 | Ssubstitute_command_keys, 1, 1, 0, |
| 707 | doc: /* Substitute key descriptions for command names in STRING. | 707 | doc: /* Substitute key descriptions for command names in STRING. |
| 708 | Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke | 708 | Each substring of the form \\=\\[COMMAND] is replaced by either a |
| 709 | sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not | 709 | keystroke sequence that invokes COMMAND, or "M-x COMMAND" if COMMAND |
| 710 | on any keys. | 710 | is not on any keys. |
| 711 | Substrings of the form \\=\\{MAPVAR} are replaced by summaries | 711 | |
| 712 | \(made by `describe-bindings') of the value of MAPVAR, taken as a keymap. | 712 | Each substring of the form \\=\\{MAPVAR} is replaced by a summary of |
| 713 | Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR | 713 | the value of MAPVAR as a keymap. This summary is similar to the one |
| 714 | produced by `describe-bindings'. The summary ends in two newlines | ||
| 715 | \(used by the helper function `help-make-xrefs' to find the end of the | ||
| 716 | summary). | ||
| 717 | |||
| 718 | Each substring of the form \\=\\<MAPVAR> specifies the use of MAPVAR | ||
| 714 | as the keymap for future \\=\\[COMMAND] substrings. | 719 | as the keymap for future \\=\\[COMMAND] substrings. |
| 715 | \\=\\= quotes the following character and is discarded; | 720 | \\=\\= quotes the following character and is discarded; |
| 716 | thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. | 721 | thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. |
| 717 | 722 | ||
| 718 | Returns original STRING if no substitutions were made. Otherwise, | 723 | Return the original STRING if no substitutions are made. |
| 719 | a new string, without any text properties, is returned. */) | 724 | Otherwise, return a new string, without any text properties. */) |
| 720 | (Lisp_Object string) | 725 | (Lisp_Object string) |
| 721 | { | 726 | { |
| 722 | char *buf; | 727 | char *buf; |