[Emacs-diffs] trunk r116739: Some doc edits related to desktop-restore-frames

[Glenn Morris]

------------------------------------------------------------
revno: 116739
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Wed 2014-03-12 00:14:30 -0700
message:
  Some doc edits related to desktop-restore-frames
  
  * doc/emacs/misc.texi (Saving Emacs Sessions):
  Be briefer about desktop's handling of frames.
  The manual does not need to mention every option, nor should
  it just repeat the doc-strings.
  
  * lisp/desktop.el (desktop-restore-frames)
  (desktop-restore-in-current-display, desktop-restore-forces-onscreen)
  (desktop-restore-reuses-frames): Doc tweaks.
  
  * etc/NEWS: Related edits.
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-03-12 07:03:40 +0000
+++ b/doc/emacs/ChangeLog       2014-03-12 07:14:30 +0000
@@ -8,6 +8,9 @@
 
 2014-03-12  Glenn Morris  <address@hidden>
 
+       * misc.texi (Saving Emacs Sessions): Be briefer about desktop's
+       handling of frames.
+
        * indent.texi (Indent Convenience): Mention electric-indent-local-mode.
 
 2014-03-02  Xue Fuqiao  <address@hidden>

=== modified file 'doc/emacs/misc.texi'
--- a/doc/emacs/misc.texi       2014-02-28 01:05:49 +0000
+++ b/doc/emacs/misc.texi       2014-03-12 07:14:30 +0000
@@ -2132,10 +2132,13 @@
 @cindex reload files
 @cindex desktop
 
address@hidden desktop-restore-frames
    Use the desktop library to save the state of Emacs from one session
 to another.  Once you save the Emacs @dfn{desktop}---the buffers,
 their file names, major modes, buffer positions, and so on---then
-subsequent Emacs sessions reload the saved desktop.
+subsequent Emacs sessions reload the saved desktop.  By default,
+the desktop also tries to save the frame and window configuration.
+To disable this, customize @code{desktop-restore-frames} to @code{nil}.
 
 @findex desktop-save
 @vindex desktop-save-mode
@@ -2193,32 +2196,6 @@
 @code{desktop-clear-preserve-buffers-regexp}, whose value is a regular
 expression matching the names of buffers not to kill.
 
address@hidden desktop-restore-frames
address@hidden, enabled by default, a address@hidden
-means save frames (@pxref{Frames}) to desktop file.
-
address@hidden desktop-restore-in-current-display
-If the value of @code{desktop-restore-in-current-display} is @code{t},
-frames are restored in the current display.  If @code{nil} (the
-default), frames are restored in their original displays if possible.
-If @samp{delete}, frames on other displays are deleted instead of
-restored.
-
address@hidden desktop-restore-reuses-frames
-If the value of @code{desktop-restore-reuses-frames} is @code{t} (the
-default), restoring frames will reuse existing frames.  If @code{nil},
-existing frames are deleted.  If @samp{:keep}, existing frames are
-kept but not reused.
-
address@hidden desktop-restore-forces-onscreen
-If the value of @code{desktop-restore-forces-onscreen} is @code{t}
-(the default), offscreen frames are restored onscreen.  If
address@hidden:all}, frames that are partially offscreen are also forced
-onscreen.  @strong{Notice:} Checking of frame boundaries is
-approximate.  It may not reliably detect frames whose
-onscreen/offscreen state depends on a few pixels, especially near the
-right and/or bottom borders of the screen.
-
   If you want to save minibuffer history from one session to
 another, use the @code{savehist} library.
 

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-03-12 06:48:20 +0000
+++ b/etc/NEWS  2014-03-12 07:14:30 +0000
@@ -572,10 +572,10 @@
 to nil (or zero).
 
 +++
-*** `desktop-restore-frames', enabled by default, allows saving and
-restoring the frame/window configuration (frameset).  Additional options
-`desktop-restore-in-current-display', `desktop-restore-reuses-frames'
-and `desktop-restore-forces-onscreen' offer further customization.
+*** Desktop now saves and restores the frame/window configuration.
+To disable this, set `desktop-restore-frames' to nil.
+See also related options `desktop-restore-reuses-frames',
+`desktop-restore-in-current-display', and `desktop-restore-forces-onscreen'.
 
 +++
 ** New Dired minor mode `dired-hide-details-mode' toggles whether details,

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-03-12 06:48:20 +0000
+++ b/lisp/ChangeLog    2014-03-12 07:14:30 +0000
@@ -1,5 +1,9 @@
 2014-03-12  Glenn Morris  <address@hidden>
 
+       * desktop.el (desktop-restore-frames)
+       (desktop-restore-in-current-display, desktop-restore-forces-onscreen)
+       (desktop-restore-reuses-frames): Doc tweaks.
+
        * electric.el (electric-indent-mode): Doc fix.
 
 2014-03-12  Juanma Barranquero  <address@hidden>

=== modified file 'lisp/desktop.el'
--- a/lisp/desktop.el   2014-03-11 00:46:07 +0000
+++ b/lisp/desktop.el   2014-03-12 07:14:30 +0000
@@ -387,15 +387,18 @@
   :group 'desktop)
 
 (defcustom desktop-restore-frames t
-  "When non-nil, save frames to desktop file."
+  "When non-nil, save and restore the frame and window configuration.
+See related options `desktop-restore-reuses-frames',
+`desktop-restore-in-current-display', and `desktop-restore-forces-onscreen'."
   :type 'boolean
   :group 'desktop
   :version "24.4")
 
 (defcustom desktop-restore-in-current-display nil
-  "If t, frames are restored in the current display.
-If nil, frames are restored, if possible, in their original displays.
-If `delete', frames on other displays are deleted instead of restored."
+  "Controls how restoring of frames treats displays.
+If t, restores frames into the current display.
+If nil, restores frames into their original displays (if possible).
+If `delete', deletes frames on other displays instead of restoring them."
   :type '(choice (const :tag "Restore in current display" t)
                 (const :tag "Restore in original display" nil)
                 (const :tag "Delete frames in other displays" delete))
@@ -403,11 +406,13 @@
   :version "24.4")
 
 (defcustom desktop-restore-forces-onscreen t
-  "If t, offscreen frames are restored onscreen instead.
-If `all', frames that are partially offscreen are also forced onscreen.
-NOTE: Checking of frame boundaries is only approximate and can fail
-to reliably detect frames whose onscreen/offscreen state depends on a
-few pixels, especially near the right / bottom borders of the screen."
+  "If t, restores frames that are fully offscreen onscreen instead.
+If `all', also restores frames that are partially offscreen onscreen.
+
+Note that checking of frame boundaries is only approximate.
+It can fail to reliably detect frames whose onscreen/offscreen state
+depends on a few pixels, especially near the right / bottom borders
+of the screen."
   :type '(choice (const :tag "Only fully offscreen frames" t)
                 (const :tag "Also partially offscreen frames" all)
                 (const :tag "Do not force frames onscreen" nil))
@@ -416,8 +421,8 @@
 
 (defcustom desktop-restore-reuses-frames t
   "If t, restoring frames reuses existing frames.
-If nil, existing frames are deleted.
-If `keep', existing frames are kept and not reused."
+If nil, deletes existing frames.
+If `keep', keeps existing frames and does not reuse them."
   :type '(choice (const :tag "Reuse existing frames" t)
                 (const :tag "Delete existing frames" nil)
                 (const :tag "Keep existing frames" :keep))