Clarify that \= only quotes the next character

4 files changed, 12 insertions, 5 deletions

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index cf6e3482efb..d18a72ef6d7 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,5 +1,9 @@
 2011-07-15  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
+        * help.texi (Keys in Documentation): Clarify that \= only quotes
+        the next character, and doesn't affect longer sequences in
+        particular (bug#8935).
+
         * debugging.texi (Using Debugger): Mention
         @code{eval-expression-debug-on-error} (bug#8549).
 
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index 0ce05d55a07..4e5bb1b247c 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -324,9 +324,8 @@ specifies @var{mapvar}'s value as the keymap for any following
 @samp{\[@var{command}]} sequences in this documentation string.
 
 @item \=
-quotes the following character and is discarded; thus, @samp{\=\[} puts
-@samp{\[} into the output, and @samp{\=\=} puts @samp{\=} into the
-output.
+quotes the following character and is discarded; thus, @samp{\=\} puts
+@samp{\} into the output.
 @end table
 
 @strong{Please note:} Each @samp{\} must be doubled when written in a
diff --git a/src/ChangeLog b/src/ChangeLog
index 8ef3efa8a52..75de3e44123 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,5 +1,9 @@
 2011-07-15  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
+        * doc.c (Fsubstitute_command_keys): Clarify that \= really only
+        quotes the next character, and doesn't affect other longer
+        sequences (bug#8935).
+
         * lread.c (syms_of_lread): Clarify that is isn't only
         `eval-buffer' and `eval-defun' that's affected by
         `lexical-binding' (bug#8460).
diff --git a/src/doc.c b/src/doc.c
index 69646f5af51..5a8dc3ce37c 100644
--- a/src/doc.c
+++ b/src/doc.c
@@ -702,8 +702,8 @@ Substrings of the form \\=\\{MAPVAR} are replaced by summaries
 \(made by `describe-bindings') of the value of MAPVAR, taken as a keymap.
 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
 as the keymap for future \\=\\[COMMAND] substrings.
-\\=\\= quotes the following character and is discarded;
-thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.
+\\=\\= quotes the following character and is discarded.
+In particular, \\=\\=\\ puts \\ into the output.
 
 Returns original STRING if no substitutions were made.  Otherwise,
 a new string, without any text properties, is returned.  */)