]> git.eshelyaron.com Git - emacs.git/commitdiff
(Regexp Search): Clarify what re-search-forward does when the search fails.
authorRichard M. Stallman <rms@gnu.org>
Wed, 6 Jul 2005 22:12:01 +0000 (22:12 +0000)
committerRichard M. Stallman <rms@gnu.org>
Wed, 6 Jul 2005 22:12:01 +0000 (22:12 +0000)
lispref/searching.texi

index c7c426ea03f4b281563f385b7b7d9f812a598603..cfb5a87d8ec07d4d2f1b61a5856c7e5288be4b5f 100644 (file)
@@ -850,17 +850,20 @@ extending after that position is accepted.
 
 If @var{repeat} is supplied, it must be a positive number; the search
 is repeated that many times; each repetition starts at the end of the
-previous match.  If all these successive searches succeed, the
-function succeeds, moving point and returning its new value.
-Otherwise the function fails.
+previous match.  If all these successive searches succeed, the search
+succeeds, moving point and returning its new value.  Otherwise the
+search fails.  What @code{re-search-forward} does when the search
+fails depends on the value of @var{noerror}:
 
-What happens when the function fails depends on the value of
-@var{noerror}.  If @var{noerror} is @code{nil}, a @code{search-failed}
-error is signaled.  If @var{noerror} is @code{t},
-@code{re-search-forward} does nothing and returns @code{nil}.  If
-@var{noerror} is neither @code{nil} nor @code{t}, then
-@code{re-search-forward} moves point to @var{limit} (or the end of the
-accessible portion of the buffer) and returns @code{nil}.
+@table @asis
+@item @code{nil}
+Signal a @code{search-failed} error.
+@item @code{t}
+Do nothing and return @code{nil}.
+@item anything else
+Move point to @var{limit} (or the end of the accessible portion of the
+buffer) and return @code{nil}.
+@end table
 
 In the following example, point is initially before the @samp{T}.
 Evaluating the search call moves point to the end of that line (between