Doc fix for with-silent-modifications

* subr.el (with-silent-modifications): Clarify somewhat what the
macro inhibits.

Fixes: debbugs:6525

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 71faf19b621d237d90a2ba302e69357aee61021e..b78a6a4c58089cb75d0ea47664a7956bc5b25cfd 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2011-07-13  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
+       * subr.el (with-silent-modifications): Clarify somewhat what the
+       macro inhibits (bug#6525).
+
        * simple.el (eval-expression): Note what it does if called
        interactively (bug#6495).
 

diff --git a/lisp/subr.el b/lisp/subr.el
index a2f560461ebb1ba315157cebf38cff3abbb33dff..5c890eefa299597c0ed02af8cfe56d478fed67f0 100644 (file)
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -3072,8 +3072,15 @@ See also `with-temp-file' and `with-output-to-string'."
   "Execute BODY, pretending it does not modify the buffer.
 If BODY performs real modifications to the buffer's text, other
 than cosmetic ones, undo data may become corrupted.
-Typically used around modifications of text-properties which do not really
-affect the buffer's content."
+
+This macro will run BODY normally, but doesn't count its buffer
+modifications as being buffer modifications.  This affects things
+like buffer-modified-p, checking whether the file is locked by
+someone else, running buffer modification hooks, and other things
+of that nature.
+
+Typically used around modifications of text-properties which do
+not really affect the buffer's content."
   (declare (debug t) (indent 0))
   (let ((modified (make-symbol "modified")))
     `(let* ((,modified (buffer-modified-p))