diff options
| author | Eli Zaretskii | 2017-01-20 10:57:14 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2017-01-20 10:57:14 +0200 |
| commit | 954e9e983b7e446ebf4a7b4dfee0dca82b6b57f7 (patch) | |
| tree | 3bb5cc751c903e2778d354ec15c17b3f10ed2983 /doc | |
| parent | 9fcab85efd10090786266610f4dbb83ee0da4b31 (diff) | |
| download | emacs-954e9e983b7e446ebf4a7b4dfee0dca82b6b57f7.tar.gz emacs-954e9e983b7e446ebf4a7b4dfee0dca82b6b57f7.zip | |
Improve documentation of hooks related to saving buffers
* lisp/files.el (write-file-functions, write-contents-functions)
(before-save-hook, after-save-hook): Note that these are only used
by save-buffer.
* doc/lispref/backups.texi (Auto-Saving):
* doc/lispref/files.texi (Saving Buffers): Mention that
save-related hooks are not run by auto-saving. (Bug#25460)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/backups.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 6 |
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/lispref/backups.texi b/doc/lispref/backups.texi index 83d826018ca..361fa81099b 100644 --- a/doc/lispref/backups.texi +++ b/doc/lispref/backups.texi | |||
| @@ -545,6 +545,11 @@ effect in an existing buffer until the next time auto-save mode is | |||
| 545 | reenabled in it. If auto-save mode is already enabled, auto-saves | 545 | reenabled in it. If auto-save mode is already enabled, auto-saves |
| 546 | continue to go in the same file name until @code{auto-save-mode} is | 546 | continue to go in the same file name until @code{auto-save-mode} is |
| 547 | called again. | 547 | called again. |
| 548 | |||
| 549 | Note that setting this variable to a non-@code{nil} value does not | ||
| 550 | change the fact that auto-saving is different from saving the buffer; | ||
| 551 | e.g., the hooks described in @ref{Saving Buffers} are @emph{not} run | ||
| 552 | when a buffer is auto-saved. | ||
| 548 | @end defopt | 553 | @end defopt |
| 549 | 554 | ||
| 550 | @defun recent-auto-save-p | 555 | @defun recent-auto-save-p |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 6f015e2d643..49cb150dc64 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -403,7 +403,11 @@ buffer name instead. | |||
| 403 | @end deffn | 403 | @end deffn |
| 404 | 404 | ||
| 405 | Saving a buffer runs several hooks. It also performs format | 405 | Saving a buffer runs several hooks. It also performs format |
| 406 | conversion (@pxref{Format Conversion}). | 406 | conversion (@pxref{Format Conversion}). Note that these hooks, |
| 407 | described below, are only run by @code{save-buffer}, they are not run | ||
| 408 | by other primitives and functions that write buffer text to files, and | ||
| 409 | in particular auto-saving (@pxref{Auto-Saving}) doesn't run these | ||
| 410 | hooks. | ||
| 407 | 411 | ||
| 408 | @defvar write-file-functions | 412 | @defvar write-file-functions |
| 409 | The value of this variable is a list of functions to be called before | 413 | The value of this variable is a list of functions to be called before |