Note caveat for backward regexp searching in docstring (Bug#31584)

* src/search.c (Fre_search_backward): Emphasize that backwards
searches may give shorter than expected matches.
* doc/lispref/searching.texi (Regexp Search): Add an anchor for
re-search-backward to reference.
This commit is contained in:
Noam Postavsky 2018-05-24 19:49:11 -04:00
parent 3145d08cae
commit 2f44d2d5b1
2 changed files with 6 additions and 1 deletions

View file

@ -1102,6 +1102,8 @@ comes back" twice.
@end example @end example
@end deffn @end deffn
@c This anchor is referenced by re-search-backward's docstring.
@anchor{re-search-backward}
@deffn Command re-search-backward regexp &optional limit noerror count @deffn Command re-search-backward regexp &optional limit noerror count
This function searches backward in the current buffer for a string of This function searches backward in the current buffer for a string of
text that is matched by the regular expression @var{regexp}, leaving text that is matched by the regular expression @var{regexp}, leaving

View file

@ -2233,8 +2233,11 @@ DEFUN ("re-search-backward", Fre_search_backward, Sre_search_backward, 1, 4,
This function is almost identical to `re-search-forward', except that This function is almost identical to `re-search-forward', except that
by default it searches backward instead of forward, and the sign of by default it searches backward instead of forward, and the sign of
COUNT also indicates exactly the opposite searching direction. COUNT also indicates exactly the opposite searching direction.
See `re-search-forward' for details.
See `re-search-forward' for details. */) Note that searching backwards may give a shorter match than expected,
because REGEXP is still matched in the forward direction. See Info
anchor `(elisp) re-search-backward' for details. */)
(Lisp_Object regexp, Lisp_Object bound, Lisp_Object noerror, Lisp_Object count) (Lisp_Object regexp, Lisp_Object bound, Lisp_Object noerror, Lisp_Object count)
{ {
return search_command (regexp, bound, noerror, count, -1, 1, 0); return search_command (regexp, bound, noerror, count, -1, 1, 0);