* searching.texi (Match Data): Note that match data can be

overwritten by most functions.

Fixes: debbugs:2499

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index f2206cd78ecac9770edaac8a09b9bb6a3e974b77..807313c8632f691523ad44288bf51015b7c37203 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2011-07-03  Tobias C. Rittweiler  <tcr@freebits.de>  (tiny change)
+
+       * searching.texi (Match Data): Note that match data can be
+       overwritten by most functions (bug#2499).
+
 2011-07-03  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
        * strings.texi (Formatting Strings): Clarify what the "-" and "0"

diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi
index 27b089f75b63aab14927c9d48f7c357986824782..6272301dbb475c1228c01ae415a1d2323d6a2c65 100644 (file)
--- 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,