[Emacs-diffs] trunk r116497: lisp/savehist.el: Fix typos in docstrings.

[Juanma Barranquero]

------------------------------------------------------------
revno: 116497
revision-id: address@hidden
parent: address@hidden
committer: Juanma Barranquero <address@hidden>
branch nick: trunk
timestamp: Fri 2014-02-21 01:47:17 +0100
message:
  lisp/savehist.el: Fix typos in docstrings.
  
  (savehist-save-minibuffer-history, savehist-additional-variables)
  (savehist-file, savehist-mode-hook, savehist-save-hook, 
savehist-coding-system)
  (savehist-loaded, savehist-load, savehist-install, savehist-autosave):
  Fix typos; mostly, refer to "Savehist mode" when talking about the mode,
  and not the function.
modified:
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/savehist.el               
savehist.el-20091113204419-o5vbwnq5f7feedwu-3943

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-02-21 00:35:08 +0000
+++ b/lisp/ChangeLog    2014-02-21 00:47:17 +0000
@@ -1,5 +1,12 @@
 2014-02-21  Juanma Barranquero  <address@hidden>
 
+       * savehist.el (savehist-save-minibuffer-history)
+       (savehist-additional-variables, savehist-file, savehist-mode-hook)
+       (savehist-save-hook, savehist-coding-system, savehist-loaded)
+       (savehist-load, savehist-install, savehist-autosave): Fix typos;
+       mostly, refer to "Savehist mode" when talking about the mode,
+       and not the function.
+
        * saveplace.el (save-place): Remove redundant info in docstring.
        (save-place-forget-unreadable-files, toggle-save-place)
        (save-place-forget-unreadable-files, save-place-dired-hook):

=== modified file 'lisp/savehist.el'
--- a/lisp/savehist.el  2014-02-10 01:34:22 +0000
+++ b/lisp/savehist.el  2014-02-21 00:47:17 +0000
@@ -60,21 +60,21 @@
 
 (defcustom savehist-save-minibuffer-history t
   "If non-nil, save all recorded minibuffer histories.
-If you want to save only specific histories, use `savehist-save-hook' to
-modify the value of `savehist-minibuffer-history-variables'."
+If you want to save only specific histories, use `savehist-save-hook'
+to modify the value of `savehist-minibuffer-history-variables'."
   :type 'boolean
   :group 'savehist)
 
 (defcustom savehist-additional-variables ()
   "List of additional variables to save.
 Each element is a symbol whose value will be persisted across Emacs
-sessions that use savehist.  The contents of variables should be
+sessions that use Savehist.  The contents of variables should be
 printable with the Lisp printer.  You don't need to add minibuffer
 history variables to this list, all minibuffer histories will be
 saved automatically as long as `savehist-save-minibuffer-history' is
 non-nil.
 
-User options should be saved with the customize interface.  This
+User options should be saved with the Customize interface.  This
 list is useful for saving automatically updated variables that are not
 minibuffer histories, such as `compile-command' or `kill-ring'."
   :type '(repeat variable)
@@ -89,7 +89,7 @@
   (locate-user-emacs-file "history" ".emacs-history")
   "File name where minibuffer history is saved to and loaded from.
 The minibuffer history is a series of Lisp expressions loaded
-automatically when `savehist-mode' is turned on.  See `savehist-mode'
+automatically when Savehist mode is turned on.  See `savehist-mode'
 for more details.
 
 If you want your minibuffer history shared between Emacs and XEmacs,
@@ -115,14 +115,14 @@
   :group 'savehist)
 
 (defcustom savehist-mode-hook nil
-  "Hook called when `savehist-mode' is turned on."
+  "Hook called when Savehist mode is turned on."
   :type 'hook
   :group 'savehist)
 
 (defcustom savehist-save-hook nil
   "Hook called by `savehist-save' before saving the variables.
-You can use this hook to influence choice and content of variables to
-save."
+You can use this hook to influence choice and content of variables
+to save."
   :type 'hook
   :group 'savehist)
 
@@ -134,7 +134,7 @@
                                        (<= emacs-major-version 21)
                                        (< emacs-minor-version 5))
                                   'iso-2022-8 'utf-8-unix)
-  "The coding system savehist uses for saving the minibuffer history.
+  "The coding system Savehist uses for saving the minibuffer history.
 Changing this value while Emacs is running is supported, but considered
 unwise, unless you know what you are doing.")
 
@@ -158,7 +158,7 @@
 
 (defvar savehist-loaded nil
   "Whether the history has already been loaded.
-This prevents toggling `savehist-mode' from destroying existing
+This prevents toggling Savehist mode from destroying existing
 minibuffer history.")
 
 (when (featurep 'xemacs)
@@ -205,7 +205,7 @@
     (savehist-install)))
 
 (defun savehist-load ()
-  "Load the variables stored in `savehist-file' and turn on `savehist-mode'.
+  "Load the variables stored in `savehist-file' and turn on Savehist mode.
 If `savehist-file' is in the old format that doesn't record
 the value of `savehist-minibuffer-history-variables', that
 value is deducted from the contents of the file."
@@ -228,7 +228,7 @@
               vars)))))
 
 (defun savehist-install ()
-  "Hook savehist into Emacs.
+  "Hook Savehist into Emacs.
 Normally invoked by calling `savehist-mode' to set the minor mode.
 Installs `savehist-autosave' in `kill-emacs-hook' and on a timer.
 To undo this, call `savehist-uninstall'."
@@ -356,7 +356,7 @@
 
 (defun savehist-autosave ()
   "Save the minibuffer history if it has been modified since the last save.
-Does nothing if `savehist-mode' is off."
+Does nothing if Savehist mode is off."
   (when savehist-mode
     (savehist-save t)))