From: Andrew Hyatt <ahyatt@gmail.com>
Date: Mon, 25 Jul 2016 03:58:47 +0000 (-0400)
Subject: Add warning to format-alist docs.
X-Git-Tag: emacs-26.0.90~1840^2~9
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=113b3852d7a51e25ec765f80a265dac0bf8fe66e;p=emacs.git

Add warning to format-alist docs.

*/doc/lispref/files.texi (format-alist) Change documentation for
format-alist to warn against file modifications when formatting, which
leads to incorrect results.  (Bug#5440)

Changes suggested by Eli.
---

diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index f3650a4556f..ea9d53b0ea6 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -3238,7 +3238,9 @@ end position.
 
 One responsibility of @var{from-fn} is to make sure that the beginning
 of the file no longer matches @var{regexp}.  Otherwise it is likely to
-get called again.
+get called again.  Also, @var{from-fn} must not involve buffers or
+files other than the one being decoded, otherwise the internal buffer
+used for formatting might be overwritten.
 
 @item to-fn
 A shell command or function to encode data in this format---that is, to
@@ -3269,6 +3271,10 @@ file, it intermixes the specified annotations at the corresponding
 positions.  All this takes place without modifying the buffer.
 @end itemize
 
+@var{to-fn} must not involve buffers or files other than the one being
+encoded, otherwise the internal buffer used for formatting might be
+overwritten.
+
 @item modify
 A flag, @code{t} if the encoding function modifies the buffer, and
 @code{nil} if it works by returning a list of annotations.