; Minor fixes in ELisp manual

* doc/lispref/searching.texi (Regexp Search): Caveat about using
'search-spaces-regexp'.  (Bug#71429)
* doc/lispref/help.texi (Keys in Documentation): Fix markup.

(cherry picked from commit e6044b29e65d3639c267bf4753391c7cc57106cf)

diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index 838579ab93d2d861a1dc0d5d11a7cedf8d567584..65ae5a33b3d8f2c5c2c9e41a1de1af628e4503f6 100644 (file)
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -334,6 +334,9 @@ stands for a key sequence that will invoke @var{command}, or @samp{M-x
 @item \@{@var{mapvar}@}
 stands for a summary of the keymap which is the value of the variable
 @var{mapvar}.  The summary is made using @code{describe-bindings}.
+The summary will normally exclude meny bindings, but if the
+@var{include-menus} argument to @code{substitute-command-keys} is
+non-@code{nil}, the menu bindings will be included.
 
 @item \<@var{mapvar}>
 stands for no text itself.  It is used only for a side effect: it
@@ -384,11 +387,6 @@ given a special face @code{help-key-binding}, but if the optional
 argument @var{no-face} is non-@code{nil}, the function doesn't add
 this face to the produced string.
 
-@defun substitute-quotes string
-This function works like @code{substitute-command-keys}, but only
-replaces quote characters.
-@end defun
-
 @cindex 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
@@ -439,6 +437,11 @@ The keymap description will normally exclude menu items, but if
 @end group
 @end smallexample
 
+@defun substitute-quotes string
+This function works like @code{substitute-command-keys}, but only
+replaces quote characters.
+@end defun
+
   There are other special conventions for the text in documentation
 strings---for instance, you can refer to functions, variables, and
 sections of this manual.  @xref{Documentation Tips}, for details.

diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi
index 2fa7ebc903d3ee796cacf6802b2d2c08de63d55f..6e3680bdb4fa4d455b269b1d061b2d9136bc2d75 100644 (file)
--- a/doc/lispref/searching.texi
+++ b/doc/lispref/searching.texi
@@ -2216,7 +2216,11 @@ this regular expression.  However, spaces inside of constructs such as
 
 Since this variable affects all regular expression search and match
 constructs, you should bind it temporarily for as small as possible
-a part of the code.
+a part of the code, and only where the Lisp code affected by the
+binding performs searches whose regexp was produced from interactive
+user input.  In other words, this variable should only be used to tell
+regexp search primitives how to interpret whitespace typed by the
+user.
 @end defvar
 
 @node Longest Match