[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master 113b385: Add warning to format-alist docs.
From: |
Andrew Hyatt |
Subject: |
[Emacs-diffs] master 113b385: Add warning to format-alist docs. |
Date: |
Tue, 26 Jul 2016 01:32:33 +0000 (UTC) |
branch: master
commit 113b3852d7a51e25ec765f80a265dac0bf8fe66e
Author: Andrew Hyatt <address@hidden>
Commit: Andrew Hyatt <address@hidden>
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.
---
doc/lispref/files.texi | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index f3650a4..ea9d53b 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
address@hidden 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.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] master 113b385: Add warning to format-alist docs.,
Andrew Hyatt <=