From e5d9c0d111daaff5d1a6ca26ebde4f926da5e410 Mon Sep 17 00:00:00 2001 From: Chong Yidong Date: Sun, 5 Aug 2012 15:45:12 +0800 Subject: [PATCH] Docfix for kill-buffer-hook and others. * lisp/files.el (kill-buffer-hook): Provide a defvar. * src/term.c (Vsuspend_tty_functions, Vresume_tty_functions): * src/frame.c (Vdelete_frame_functions): * src/emacs.c (Vkill_emacs_hook): Doc fix. --- lisp/ChangeLog | 4 ++++ lisp/files.el | 6 +++++- src/ChangeLog | 6 ++++++ src/emacs.c | 2 +- src/frame.c | 2 +- src/term.c | 4 ++-- 6 files changed, 19 insertions(+), 5 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 7e9da4fa8f..71d7b50482 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,7 @@ +2012-08-05 Chong Yidong + + * files.el (kill-buffer-hook): Provide a defvar. + 2012-08-05 Glenn Morris * eshell/esh-ext.el (eshell/addpath): diff --git a/lisp/files.el b/lisp/files.el index 2b4ae460c3..b54d3d1b60 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -1514,7 +1514,11 @@ expand wildcards (if any) and replace the file with multiple files." (other-window 1) (find-alternate-file filename wildcards)))) -(defvar kill-buffer-hook) ; from buffer.c +;; Defined and used in buffer.c, but not as a DEFVAR_LISP. +(defvar kill-buffer-hook nil + "Hook run when a buffer is killed. +The buffer being killed is current while the hook is running. +See `kill-buffer'.") (defun find-alternate-file (filename &optional wildcards) "Find file FILENAME, select its buffer, kill previous buffer. diff --git a/src/ChangeLog b/src/ChangeLog index 4b60dd07e7..8d13944b63 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,9 @@ +2012-08-05 Chong Yidong + + * term.c (Vsuspend_tty_functions, Vresume_tty_functions): + * frame.c (Vdelete_frame_functions): + * emacs.c (Vkill_emacs_hook): Doc fix. + 2012-08-04 Eli Zaretskii * xfns.c (x_set_menu_bar_lines): Fix compilation error in diff --git a/src/emacs.c b/src/emacs.c index c99ed7c4b0..223d125db3 100644 --- a/src/emacs.c +++ b/src/emacs.c @@ -2424,7 +2424,7 @@ Emacs is running. */); doc: /* Non-nil means Emacs is running without interactive terminal. */); DEFVAR_LISP ("kill-emacs-hook", Vkill_emacs_hook, - doc: /* Hook to be run when `kill-emacs' is called. + doc: /* Hook run when `kill-emacs' is called. Since `kill-emacs' may be invoked when the terminal is disconnected (or in other similar situations), functions placed on this hook should not expect to be able to interact with the user. To ask for confirmation, diff --git a/src/frame.c b/src/frame.c index e43352d4e2..308179e206 100644 --- a/src/frame.c +++ b/src/frame.c @@ -4351,7 +4351,7 @@ The pointer becomes visible again when the mouse is moved. */); Vmake_pointer_invisible = Qt; DEFVAR_LISP ("delete-frame-functions", Vdelete_frame_functions, - doc: /* Functions to be run before deleting a frame. + doc: /* Functions run before deleting a frame. The functions are run with one arg, the frame to be deleted. See `delete-frame'. diff --git a/src/term.c b/src/term.c index 803bb6458b..64bc88a7cf 100644 --- a/src/term.c +++ b/src/term.c @@ -3571,14 +3571,14 @@ This variable can be used by terminal emulator packages. */); #endif DEFVAR_LISP ("suspend-tty-functions", Vsuspend_tty_functions, - doc: /* Functions to be run after suspending a tty. + doc: /* Functions run after suspending a tty. The functions are run with one argument, the terminal object to be suspended. See `suspend-tty'. */); Vsuspend_tty_functions = Qnil; DEFVAR_LISP ("resume-tty-functions", Vresume_tty_functions, - doc: /* Functions to be run after resuming a tty. + doc: /* Functions run after resuming a tty. The functions are run with one argument, the terminal object that was revived. See `resume-tty'. */); Vresume_tty_functions = Qnil; -- 2.20.1