[Emacs-diffs] trunk r116468: Some desktop doc

[Glenn Morris]

------------------------------------------------------------
revno: 116468
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Mon 2014-02-17 17:33:30 -0800
message:
  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.
modified:
  doc/emacs/ChangeLog            changelog-20091113204419-o5vbwnq5f7feedwu-6227
  doc/emacs/misc.texi            misc.texi-20091113204419-o5vbwnq5f7feedwu-6267
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/desktop.el                desktop.el-20091113204419-o5vbwnq5f7feedwu-591

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2014-02-17 18:04:17 +0000
+++ b/doc/emacs/ChangeLog       2014-02-18 01:33:30 +0000
@@ -1,3 +1,7 @@
+2014-02-18  Glenn Morris  <address@hidden>
+
+       * misc.texi (Saving Emacs Sessions): Mention desktop-auto-save-timeout.
+
 2014-02-17  Stefan Monnier  <address@hidden>
 
        * programs.texi (Matching): Fix typo.

=== modified file 'doc/emacs/misc.texi'
--- a/doc/emacs/misc.texi       2014-02-03 07:35:44 +0000
+++ b/doc/emacs/misc.texi       2014-02-18 01:33:30 +0000
@@ -2150,6 +2150,12 @@
 (desktop-save-mode 1)
 @end example
 
address@hidden desktop-auto-save-timeout
address@hidden
+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 address@hidden and non-zero.
+
 @findex desktop-change-dir
 @findex desktop-revert
 @vindex desktop-path

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-02-17 18:04:17 +0000
+++ b/etc/NEWS  2014-02-18 01:33:30 +0000
@@ -468,8 +468,10 @@
 
 ** 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

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-02-17 18:16:32 +0000
+++ b/lisp/ChangeLog    2014-02-18 01:33:30 +0000
@@ -1,3 +1,7 @@
+2014-02-18  Glenn Morris  <address@hidden>
+
+       * desktop.el (desktop-save-mode, desktop-auto-save-timeout): Doc fixes.
+
 2014-02-17  Alan Mackenzie  <address@hidden>
 
        Connect electric-indent-mode up with CC Mode.  Bug #15478.

=== modified file 'lisp/desktop.el'
--- a/lisp/desktop.el   2014-02-07 07:58:10 +0000
+++ b/lisp/desktop.el   2014-02-18 01:33:30 +0000
@@ -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 <address@hidden>
 ;; Keywords: convenience
@@ -154,13 +153,24 @@
 ;;;###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.
-
-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."
+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.
+
+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 @@
 
 (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 @@
 (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.