summaryrefslogtreecommitdiff
path: root/doc/lispref/searching.texi
diff options
context:
space:
mode:
authorTobias C. Rittweiler <tcr@freebits.de>2011-07-03 20:44:53 +0200
committerLars Magne Ingebrigtsen <larsi@gnus.org>2011-07-03 20:44:53 +0200
commitd2a6c43b6fd3f393924b024b33e30b560b2d2adc (patch)
tree5b8f3e15aeed6558e5d5bbc991daecdaab4232dd /doc/lispref/searching.texi
parent9a51c6c761e8cfae9542bde51186be7c92c10db5 (diff)
downloademacs-d2a6c43b6fd3f393924b024b33e30b560b2d2adc.tar.gz
* searching.texi (Match Data): Note that match data can be
overwritten by most functions. Fixes: debbugs:2499
Diffstat (limited to 'doc/lispref/searching.texi')
-rw-r--r--doc/lispref/searching.texi6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi
index 27b089f75b6..6272301dbb4 100644
--- a/doc/lispref/searching.texi
+++ b/doc/lispref/searching.texi
@@ -1207,6 +1207,12 @@ search you wish to refer back to and the use of the match data. If you
can't avoid another intervening search, you must save and restore the
match data around it, to prevent it from being overwritten.
+ Notice that all functions are allowed to overwrite the match data
+unless they're explicitly documented not to do so. A consequence is
+that functions that are run implictly in the background
+(@pxref{Timers}, and @ref{Idle Timers}) should likely save and restore
+the match data explicitly.
+
@menu
* Replacing Match:: Replacing a substring that was matched.
* Simple Match Data:: Accessing single items of match data,