aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/files.texi8
1 files changed, 7 insertions, 1 deletions
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.
3238 3238
3239One responsibility of @var{from-fn} is to make sure that the beginning 3239One responsibility of @var{from-fn} is to make sure that the beginning
3240of the file no longer matches @var{regexp}. Otherwise it is likely to 3240of the file no longer matches @var{regexp}. Otherwise it is likely to
3241get called again. 3241get called again. Also, @var{from-fn} must not involve buffers or
3242files other than the one being decoded, otherwise the internal buffer
3243used for formatting might be overwritten.
3242 3244
3243@item to-fn 3245@item to-fn
3244A shell command or function to encode data in this format---that is, to 3246A 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
3269positions. All this takes place without modifying the buffer. 3271positions. All this takes place without modifying the buffer.
3270@end itemize 3272@end itemize
3271 3273
3274@var{to-fn} must not involve buffers or files other than the one being
3275encoded, otherwise the internal buffer used for formatting might be
3276overwritten.
3277
3272@item modify 3278@item modify
3273A flag, @code{t} if the encoding function modifies the buffer, and 3279A flag, @code{t} if the encoding function modifies the buffer, and
3274@code{nil} if it works by returning a list of annotations. 3280@code{nil} if it works by returning a list of annotations.