diff options
author | Andrew Hyatt <ahyatt@gmail.com> | 2016-07-24 23:58:47 -0400 |
---|---|---|
committer | Andrew Hyatt <ahyatt@gmail.com> | 2016-07-25 21:31:48 -0400 |
commit | 113b3852d7a51e25ec765f80a265dac0bf8fe66e (patch) | |
tree | 4dee292973fe66126a0330c0b442e5289dfba0b8 /doc | |
parent | 520522674e501f5a3517323b5751a04c58582c65 (diff) |
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.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/files.texi | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index f3650a4556..ea9d53b0ea 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. |