[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
emacs-28 d5e1424174: Expand docstrings related to auto-saving
From: |
Stefan Kangas |
Subject: |
emacs-28 d5e1424174: Expand docstrings related to auto-saving |
Date: |
Mon, 4 Jul 2022 18:33:08 -0400 (EDT) |
branch: emacs-28
commit d5e14241744d2994102b5e66db48c9ebc406861d
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
Expand docstrings related to auto-saving
* lisp/files.el (auto-save-visited-mode):
* lisp/simple.el (auto-save-mode): Expand docstring.
---
lisp/files.el | 7 ++++++-
lisp/simple.el | 14 +++++++++++++-
2 files changed, 19 insertions(+), 2 deletions(-)
diff --git a/lisp/files.el b/lisp/files.el
index ea57f02ac0..752986b478 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -421,6 +421,9 @@ idle for `auto-save-visited-interval' seconds."
(define-minor-mode auto-save-visited-mode
"Toggle automatic saving to file-visiting buffers on or off.
+When this mode is enabled, visited files are saved automatically.
+The user option `auto-save-visited-interval' controls how often.
+
Unlike `auto-save-mode', this mode will auto-save buffer contents
to the visited files directly and will also run all save-related
hooks. See Info node `Saving' for details of the save process.
@@ -429,7 +432,9 @@ You can also set the buffer-local value of the variable
`auto-save-visited-mode' to nil. A buffer where the buffer-local
value of this variable is nil is ignored for the purpose of
`auto-save-visited-mode', even if `auto-save-visited-mode' is
-enabled."
+enabled.
+
+For more details, see Info node `(emacs) Auto Save Files'."
:group 'auto-save
:global t
(when auto-save--timer (cancel-timer auto-save--timer))
diff --git a/lisp/simple.el b/lisp/simple.el
index d235eb9745..dca8589be4 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -8398,7 +8398,19 @@ presented."
:global t :group 'mode-line)
(define-minor-mode auto-save-mode
- "Toggle auto-saving in the current buffer (Auto Save mode)."
+ "Toggle auto-saving in the current buffer (Auto Save mode).
+
+When this mode is enabled, Emacs periodically saves each visited
+file in a separate file called the \"auto-save file\". This is a
+safety measure to prevent you from losing more than a limited
+amount of work if the system crashes.
+
+Auto-saving does not alter the file you actually use: the visited
+file is changed only when you request saving it explicitly (such
+as with \\[save-buffer]). If you want to save visited files
+automatically, use \\[auto-save-visited-mode]).
+
+For more details, see Info node `(emacs) Auto Save'."
:variable ((and buffer-auto-save-file-name
;; If auto-save is off because buffer has shrunk,
;; then toggling should turn it on.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- emacs-28 d5e1424174: Expand docstrings related to auto-saving,
Stefan Kangas <=