[Emacs-diffs] /srv/bzr/emacs/trunk r112434: * lisp/isearch.el (isearch-forward, isearch-mode): Doc fix.

[Juri Linkov]

------------------------------------------------------------
revno: 112434
fixes bug: http://debbugs.gnu.org/13923
committer: Juri Linkov <address@hidden>
branch nick: trunk
timestamp: Wed 2013-05-01 11:10:12 +0300
message:
  * lisp/isearch.el (isearch-forward, isearch-mode): Doc fix.
modified:
  lisp/ChangeLog
  lisp/isearch.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2013-05-01 08:05:05 +0000
+++ b/lisp/ChangeLog    2013-05-01 08:10:12 +0000
@@ -1,5 +1,9 @@
 2013-05-01  Juri Linkov  <address@hidden>
 
+       * isearch.el (isearch-forward, isearch-mode): Doc fix.  (Bug#13923)
+
+2013-05-01  Juri Linkov  <address@hidden>
+
        * comint.el (comint-previous-matching-input): Don't print message
        "History item: %d" when `isearch-mode' is active.
        (comint-history-isearch-message): Print message "History item: %d"

=== modified file 'lisp/isearch.el'
--- a/lisp/isearch.el   2013-04-27 22:03:42 +0000
+++ b/lisp/isearch.el   2013-05-01 08:10:12 +0000
@@ -735,8 +735,9 @@
  and are then executed normally (depending on `search-exit-option').
 Likewise for function keys and mouse button events.
 
-If this function is called non-interactively, it does not return to
-the calling function until the search is done."
+If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
+it does not return to the calling function until the search is done.
+See the function `isearch-mode' for more information."
 
   (interactive "P\np")
   (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
@@ -799,7 +800,23 @@
 
 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word)
   "Start Isearch minor mode.
-It is called by the function `isearch-forward' and other related functions."
+It is called by the function `isearch-forward' and other related functions.
+
+The non-nil arg FORWARD means searching in the forward direction.
+
+The non-nil arg REGEXP does an incremental regular expression search.
+
+The arg OP-FUN is a function to be called after each input character
+is processed.  (It is not called after characters that exit the search.)
+
+When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
+does not return to the calling function until the search is completed.
+To behave this way it enters a recursive-edit and exits it when done
+isearching.
+
+The arg WORD, if t, does incremental search for a sequence of words,
+ignoring punctuation.  If the value is a function, it is called to
+convert the search string to a regexp used by regexp search functions."
 
   ;; Initialize global vars.
   (setq isearch-forward forward