From c863b6ade69aaac9db586b38654dd1f28b7b5870 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Mon, 17 Feb 2014 17:33:30 -0800 Subject: [PATCH] Some desktop doc * doc/emacs/misc.texi (Saving Emacs Sessions): Mention desktop-auto-save-timeout. * lisp/desktop.el (desktop-save-mode, desktop-auto-save-timeout): Doc fixes. * etc/NEWS: Related edit. --- doc/emacs/ChangeLog | 4 ++++ doc/emacs/misc.texi | 6 ++++++ etc/NEWS | 6 ++++-- lisp/ChangeLog | 4 ++++ lisp/desktop.el | 28 ++++++++++++++++++++-------- 5 files changed, 38 insertions(+), 10 deletions(-) diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index e2947083ba1..fbb2dbbf092 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,7 @@ +2014-02-18 Glenn Morris + + * misc.texi (Saving Emacs Sessions): Mention desktop-auto-save-timeout. + 2014-02-17 Stefan Monnier * programs.texi (Matching): Fix typo. diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index e2151e9144c..d9bfcca3ca3 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -2150,6 +2150,12 @@ sessions, or add this line in your init file (@pxref{Init File}): (desktop-save-mode 1) @end example +@vindex desktop-auto-save-timeout +@noindent +When @code{desktop-save-mode} is active and the desktop file exists, +Emacs auto-saves it every @code{desktop-auto-save-timeout} +seconds, if that is non-@code{nil} and non-zero. + @findex desktop-change-dir @findex desktop-revert @vindex desktop-path diff --git a/etc/NEWS b/etc/NEWS index 495f119443a..844a71b9a90 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -468,8 +468,10 @@ if your version doesn't support that option. See option `cfengine-cf-promises'. ** Desktop -*** `desktop-auto-save-timeout' defines the number of seconds idle time -before auto-save of the desktop. ++++ +*** `desktop-save-mode' by default now auto-saves an existing desktop file +after `desktop-auto-save-timeout'. To disable this, customize that option +to nil (or zero). *** `desktop-restore-frames', enabled by default, allows saving and restoring the frame/window configuration (frameset). Additional options diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 5dad77bcdf9..2eb5057cf68 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,7 @@ +2014-02-18 Glenn Morris + + * desktop.el (desktop-save-mode, desktop-auto-save-timeout): Doc fixes. + 2014-02-17 Alan Mackenzie Connect electric-indent-mode up with CC Mode. Bug #15478. diff --git a/lisp/desktop.el b/lisp/desktop.el index 3380e39445b..6ec3ceed9df 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el @@ -1,7 +1,6 @@ ;;; desktop.el --- save partial status of Emacs when killed -*- lexical-binding: t -*- -;; Copyright (C) 1993-1995, 1997, 2000-2014 Free Software Foundation, -;; Inc. +;; Copyright (C) 1993-1995, 1997, 2000-2014 Free Software Foundation, Inc. ;; Author: Morten Welinder ;; Keywords: convenience @@ -154,13 +153,24 @@ backward compatibility.") ;;;###autoload (define-minor-mode desktop-save-mode "Toggle desktop saving (Desktop Save mode). -With a prefix argument ARG, enable Desktop Save mode if ARG is -positive, and disable it otherwise. If called from Lisp, enable -the mode if ARG is omitted or nil. +With a prefix argument ARG, enable Desktop Save mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode if ARG +is omitted or nil. -If Desktop Save mode is enabled, the state of Emacs is saved from -one session to another. See variable `desktop-save' and function -`desktop-read' for details." +When Desktop Save mode is enabled, the state of Emacs is saved from +one session to another. In particular, Emacs will save the desktop when +it exits (this may prompt you; see the option `desktop-save'). The next +time Emacs starts, if this mode is active it will restore the desktop. + +To manually save the desktop at any time, use the command `M-x desktop-save'. +To load it, use `M-x desktop-read'. + +Once a desktop file exists, Emacs will auto-save it according to the +option `desktop-auto-save-timeout'. + +To see all the options you can set, browse the `desktop' customization group. + +For further details, see info node `(emacs)Saving Emacs Sessions'." :global t :group 'desktop (if desktop-save-mode @@ -197,6 +207,7 @@ determine where the desktop is saved." (defcustom desktop-auto-save-timeout auto-save-timeout "Number of seconds idle time before auto-save of the desktop. +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) (integer :tag "Seconds")) @@ -1055,6 +1066,7 @@ being set (usually, by reading it from the desktop)." (defvar desktop-buffer-ok-count) (defvar desktop-buffer-fail-count) +;; FIXME Interactively, this should have the option to prompt for dirname. ;;;###autoload (defun desktop-read (&optional dirname) "Read and process the desktop file in directory DIRNAME. -- 2.39.2