From d43b486f6c334ba88c4ecfc485b8d1102b8d20a3 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 28 Oct 2017 15:11:08 +0300 Subject: [PATCH] Fix doc strings in desktop.el * lisp/desktop.el (desktop-auto-save-timeout) (desktop-auto-save-set-timer): Doc fixes. (Bug#28945) --- lisp/desktop.el | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/lisp/desktop.el b/lisp/desktop.el index 52cdbaf849d..2e53b15af38 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el @@ -216,8 +216,9 @@ determine where the desktop is saved." :version "22.1") (defcustom desktop-auto-save-timeout auto-save-timeout - "Number of seconds idle time before auto-save of the desktop. -The idle timer activates auto-saving only when window configuration changes. + "Number of seconds of idle time before auto-saving the desktop. +The desktop will be auto-saved when this amount of idle time have +passed after some change in the window configuration. This applies to an existing desktop file when `desktop-save-mode' is enabled. Zero or nil means disable auto-saving due to idleness." :type '(choice (const :tag "Off" nil) @@ -1362,10 +1363,11 @@ Called by the timer created in `desktop-auto-save-set-timer'." (desktop-save desktop-dirname nil t))) (defun desktop-auto-save-set-timer () - "Set the auto-save timer. + "Set the desktop auto-save timer. Cancel any previous timer. When `desktop-auto-save-timeout' is a positive -integer, start a new idle timer to call `desktop-auto-save' repeatedly -after that many seconds of idle time." +integer, start a new idle timer to call `desktop-auto-save' after that many +seconds of idle time. +This function is called from `window-configuration-change-hook'." (desktop-auto-save-cancel-timer) (when (and (integerp desktop-auto-save-timeout) (> desktop-auto-save-timeout 0)) -- 2.39.2