From: Hong Xu <hong@topbug.net>
To: 25193@debbugs.gnu.org
Subject: bug#25193: [PATCH] Improve the doc of re-search-forward and re-search-backward.
Date: Mon, 12 Dec 2016 19:20:31 -0800 [thread overview]
Message-ID: <1481599231-19381-1-git-send-email-hong@topbug.net> (raw)
* search.c (Fre_search_forward, Fre_search_backward): Improve doc.
---
src/search.c | 58 ++++++++++++++++++++++++----------------------------------
1 file changed, 24 insertions(+), 34 deletions(-)
diff --git a/src/search.c b/src/search.c
index 9f55d728362a..81edc27ecdc8 100644
--- a/src/search.c
+++ b/src/search.c
@@ -2257,26 +2257,12 @@ See also the functions `match-beginning', `match-end' and `replace-match'. */)
DEFUN ("re-search-backward", Fre_search_backward, Sre_search_backward, 1, 4,
"sRE search backward: ",
- doc: /* Search backward from point for match for regular expression REGEXP.
-Set point to the beginning of the occurrence found, and return point.
-An optional second argument bounds the search; it is a buffer position.
- The match found must not begin before that position. A value of nil
- means search to the beginning of the accessible portion of the buffer.
-Optional third argument, if t, means if fail just return nil (no error).
- If not nil and not t, position at limit of search and return nil.
-Optional fourth argument COUNT, if a positive number, means to search
- for COUNT successive occurrences. If COUNT is negative, search
- forward, instead of backward, for -COUNT occurrences. A value of
- nil means the same as 1.
-With COUNT positive, the match found is the COUNTth to last one (or
- last, if COUNT is 1 or nil) in the buffer located entirely before
- the origin of the search; correspondingly with COUNT negative.
-
-Search case-sensitivity is determined by the value of the variable
-`case-fold-search', which see.
+ doc: /* Search backward from point for regular expression REGEXP.
+This function is almost identical to `re-search-forward', except for
+that by default it searches backward instead of forward, and the sign
+of COUNT also indicates exactly the opposite searching direction.
-See also the functions `match-beginning', `match-end', `match-string',
-and `replace-match'. */)
+See `re-search-forward' for details. */)
(Lisp_Object regexp, Lisp_Object bound, Lisp_Object noerror, Lisp_Object count)
{
return search_command (regexp, bound, noerror, count, -1, 1, 0);
@@ -2286,21 +2272,25 @@ DEFUN ("re-search-forward", Fre_search_forward, Sre_search_forward, 1, 4,
"sRE search: ",
doc: /* Search forward from point for regular expression REGEXP.
Set point to the end of the occurrence found, and return point.
-An optional second argument bounds the search; it is a buffer position.
- The match found must not end after that position. A value of nil
- means search to the end of the accessible portion of the buffer.
-Optional third argument, if t, means if fail just return nil (no error).
- If not nil and not t, move to limit of search and return nil.
-Optional fourth argument COUNT, if a positive number, means to search
- for COUNT successive occurrences. If COUNT is negative, search
- backward, instead of forward, for -COUNT occurrences. A value of
- nil means the same as 1.
-With COUNT positive, the match found is the COUNTth one (or first,
- if COUNT is 1 or nil) in the buffer located entirely after the
- origin of the search; correspondingly with COUNT negative.
-
-Search case-sensitivity is determined by the value of the variable
-`case-fold-search', which see.
+The optional second argument BOUND is a buffer position that bounds
+ the search. The match found must not end after that position. A
+ value of nil means search to the end of the accessible portion of
+ the buffer.
+The optional third argument NOERROR indicates how errors are handled
+ when the search fails. If it is nil or omitted, emit an error; if
+ it is t, simply return nil and do nothing; if it is neither nil nor
+ t, move to the limit of search and return nil.
+The optional fourth argument COUNT is a number that indicates the
+ search direction and the number of occurrences to search for. If it
+ is positive, search forward for COUNT successive occurrences; if it
+ is negative, search backward, instead of forward, for -COUNT
+ occurrences. A value of nil means the same as 1.
+With COUNT positive/negative, the match found is the COUNTth/-COUNTth
+ one in the buffer located entirely after/before the origin of the
+ search.
+
+Search case-sensitivity is determined by the variable
+`case-fold-search'.
See also the functions `match-beginning', `match-end', `match-string',
and `replace-match'. */)
--
2.1.4
next reply other threads:[~2016-12-13 3:20 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-13 3:20 Hong Xu [this message]
2016-12-13 6:27 ` bug#25193: [PATCH] Improve the doc of re-search-forward and re-search-backward Tino Calancha
2017-04-02 4:42 ` npostavs
2017-04-02 4:57 ` Tino Calancha
2017-04-02 6:21 ` eliz
2017-04-06 23:19 ` npostavs
2017-04-14 15:12 ` Nicolas Petton
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1481599231-19381-1-git-send-email-hong@topbug.net \
--to=hong@topbug.net \
--cc=25193@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.