]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/savehist.el (savehist-mode): Doc fix. (Bug#32889)
authorEli Zaretskii <eliz@gnu.org>
Mon, 1 Oct 2018 07:45:33 +0000 (10:45 +0300)
committerEli Zaretskii <eliz@gnu.org>
Mon, 1 Oct 2018 07:45:33 +0000 (10:45 +0300)
lisp/savehist.el

index fbb5f533902f538c004f50a2ca9c1af16841f7a1..893590ce809614af026f4b24c66b2da8e5480edc 100644 (file)
@@ -172,13 +172,30 @@ minibuffer history.")
 (define-minor-mode savehist-mode
   "Toggle saving of minibuffer history (Savehist mode).
 With a prefix argument ARG, enable Savehist mode if ARG is
-positive, and disable it otherwise.  If called from Lisp, enable
-the mode if ARG is omitted or nil.
+positive, and disable it otherwise.  If called from Lisp,
+also enable the mode if ARG is omitted or nil.
 
 When Savehist mode is enabled, minibuffer history is saved
-periodically and when exiting Emacs.  When Savehist mode is
-enabled for the first time in an Emacs session, it loads the
-previous minibuffer history from `savehist-file'.
+to `savehist-file' periodically and when exiting Emacs.  When
+Savehist mode is enabled for the first time in an Emacs session,
+it loads the previous minibuffer histories from `savehist-file'.
+The variable `savehist-autosave-interval' controls the
+periodicity of saving minibuffer histories.
+
+If `savehist-save-minibuffer-history' is non-nil (the default),
+all recorded minibuffer histories will be saved.  You can arrange
+for additional history variables to be saved and restored by
+customizing `savehist-additional-variables', which by default is
+an empty list.  For example, to save the history of commands
+invoked via \\[execute-extended-command], add `command-history' to the list in
+`savehist-additional-variables'.
+
+Alternatively, you could customize `savehist-save-minibuffer-history'
+to nil, and add to `savehist-additional-variables' only those
+history variables you want to save.
+
+To ignore some history variables, add their symbols to the list
+in `savehist-ignored-variables'.
 
 This mode should normally be turned on from your Emacs init file.
 Calling it at any other time replaces your current minibuffer