From: Stefan Kangas <stefankangas@gmail.com>
Date: Thu, 1 Feb 2024 08:08:19 +0000 (+0100)
Subject: Improve `desktop-save-mode` docstring
X-Git-Tag: archive/raspbian/1%29.4+1-4+rpi1~1^2~2^2~18^2~79
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=5ce02c91bc128f390bcf0beb82e37a3fa7f251ba;p=emacs.git

Improve `desktop-save-mode` docstring

* lisp/desktop.el (desktop-save-mode): Improve docstring.
---

diff --git a/lisp/desktop.el b/lisp/desktop.el
index 56841b49595..9100d825547 100644
--- a/lisp/desktop.el
+++ b/lisp/desktop.el
@@ -163,13 +163,22 @@ Used at desktop read to provide backward compatibility.")
 (define-minor-mode desktop-save-mode
   "Toggle desktop saving (Desktop Save mode).
 
-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.
+When Desktop Save mode is enabled, the state of Emacs is saved from one
+session to another.  The saved Emacs \"desktop configuration\" includes the
+buffers, their file names, major modes, buffer positions, window and frame
+configuration, and some important global variables.
 
-To manually save the desktop at any time, use the command `\\[desktop-save]'.
-To load it, use `\\[desktop-read]'.
+To enable this feature for future sessions, customize `desktop-save-mode'
+to t, or add this line in your init file:
+
+    (desktop-save-mode 1)
+
+When this mode is enabled, 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 \\[desktop-save].
+To load it, use \\[desktop-read].
 
 Once a desktop file exists, Emacs will auto-save it according to the
 option `desktop-auto-save-timeout'.