aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorEli Zaretskii2017-01-20 10:57:14 +0200
committerEli Zaretskii2017-01-20 10:57:14 +0200
commit954e9e983b7e446ebf4a7b4dfee0dca82b6b57f7 (patch)
tree3bb5cc751c903e2778d354ec15c17b3f10ed2983 /lisp
parent9fcab85efd10090786266610f4dbb83ee0da4b31 (diff)
downloademacs-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 'lisp')
-rw-r--r--lisp/files.el10
1 files changed, 7 insertions, 3 deletions
diff --git a/lisp/files.el b/lisp/files.el
index a6fe381a50a..83ef4e271cd 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -440,7 +440,8 @@ functions are called."
440 440
441(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1") 441(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
442(defvar write-file-functions nil 442(defvar write-file-functions nil
443 "List of functions to be called before writing out a buffer to a file. 443 "List of functions to be called before saving a buffer to a file.
444Only used by `save-buffer'.
444If one of them returns non-nil, the file is considered already written 445If one of them returns non-nil, the file is considered already written
445and the rest are not called. 446and the rest are not called.
446These hooks are considered to pertain to the visited file. 447These hooks are considered to pertain to the visited file.
@@ -465,6 +466,7 @@ updates before the buffer is saved, use `before-save-hook'.")
465 'write-contents-functions "22.1") 466 'write-contents-functions "22.1")
466(defvar write-contents-functions nil 467(defvar write-contents-functions nil
467 "List of functions to be called before writing out a buffer to a file. 468 "List of functions to be called before writing out a buffer to a file.
469Only used by `save-buffer'.
468If one of them returns non-nil, the file is considered already written 470If one of them returns non-nil, the file is considered already written
469and the rest are not called and neither are the functions in 471and the rest are not called and neither are the functions in
470`write-file-functions'. 472`write-file-functions'.
@@ -4721,13 +4723,15 @@ the last real save, but optional arg FORCE non-nil means delete anyway."
4721 "Normal hook run just before auto-saving.") 4723 "Normal hook run just before auto-saving.")
4722 4724
4723(defcustom before-save-hook nil 4725(defcustom before-save-hook nil
4724 "Normal hook that is run before a buffer is saved to its file." 4726 "Normal hook that is run before a buffer is saved to its file.
4727Only used by `save-buffer'."
4725 :options '(copyright-update time-stamp) 4728 :options '(copyright-update time-stamp)
4726 :type 'hook 4729 :type 'hook
4727 :group 'files) 4730 :group 'files)
4728 4731
4729(defcustom after-save-hook nil 4732(defcustom after-save-hook nil
4730 "Normal hook that is run after a buffer is saved to its file." 4733 "Normal hook that is run after a buffer is saved to its file.
4734Only used by `save-buffer'."
4731 :options '(executable-make-buffer-file-executable-if-script-p) 4735 :options '(executable-make-buffer-file-executable-if-script-p)
4732 :type 'hook 4736 :type 'hook
4733 :group 'files) 4737 :group 'files)