diff options
| author | Juanma Barranquero | 2014-02-21 01:47:17 +0100 |
|---|---|---|
| committer | Juanma Barranquero | 2014-02-21 01:47:17 +0100 |
| commit | fdcfd745408c935d673537bef1f4e8d294477601 (patch) | |
| tree | 537aa432570a29d80f0728a32ff91fadc3634f21 | |
| parent | 99e15133782c3aa21bb9aa19fb06dbe42941e763 (diff) | |
| download | emacs-fdcfd745408c935d673537bef1f4e8d294477601.tar.gz emacs-fdcfd745408c935d673537bef1f4e8d294477601.zip | |
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.
| -rw-r--r-- | lisp/ChangeLog | 7 | ||||
| -rw-r--r-- | lisp/savehist.el | 26 |
2 files changed, 20 insertions, 13 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 0225646ce91..97c4e0ee9a9 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,5 +1,12 @@ | |||
| 1 | 2014-02-21 Juanma Barranquero <lekktu@gmail.com> | 1 | 2014-02-21 Juanma Barranquero <lekktu@gmail.com> |
| 2 | 2 | ||
| 3 | * savehist.el (savehist-save-minibuffer-history) | ||
| 4 | (savehist-additional-variables, savehist-file, savehist-mode-hook) | ||
| 5 | (savehist-save-hook, savehist-coding-system, savehist-loaded) | ||
| 6 | (savehist-load, savehist-install, savehist-autosave): Fix typos; | ||
| 7 | mostly, refer to "Savehist mode" when talking about the mode, | ||
| 8 | and not the function. | ||
| 9 | |||
| 3 | * saveplace.el (save-place): Remove redundant info in docstring. | 10 | * saveplace.el (save-place): Remove redundant info in docstring. |
| 4 | (save-place-forget-unreadable-files, toggle-save-place) | 11 | (save-place-forget-unreadable-files, toggle-save-place) |
| 5 | (save-place-forget-unreadable-files, save-place-dired-hook): | 12 | (save-place-forget-unreadable-files, save-place-dired-hook): |
diff --git a/lisp/savehist.el b/lisp/savehist.el index 14085e5e574..6abc29cccc2 100644 --- a/lisp/savehist.el +++ b/lisp/savehist.el | |||
| @@ -60,21 +60,21 @@ | |||
| 60 | 60 | ||
| 61 | (defcustom savehist-save-minibuffer-history t | 61 | (defcustom savehist-save-minibuffer-history t |
| 62 | "If non-nil, save all recorded minibuffer histories. | 62 | "If non-nil, save all recorded minibuffer histories. |
| 63 | If you want to save only specific histories, use `savehist-save-hook' to | 63 | If you want to save only specific histories, use `savehist-save-hook' |
| 64 | modify the value of `savehist-minibuffer-history-variables'." | 64 | to modify the value of `savehist-minibuffer-history-variables'." |
| 65 | :type 'boolean | 65 | :type 'boolean |
| 66 | :group 'savehist) | 66 | :group 'savehist) |
| 67 | 67 | ||
| 68 | (defcustom savehist-additional-variables () | 68 | (defcustom savehist-additional-variables () |
| 69 | "List of additional variables to save. | 69 | "List of additional variables to save. |
| 70 | Each element is a symbol whose value will be persisted across Emacs | 70 | Each element is a symbol whose value will be persisted across Emacs |
| 71 | sessions that use savehist. The contents of variables should be | 71 | sessions that use Savehist. The contents of variables should be |
| 72 | printable with the Lisp printer. You don't need to add minibuffer | 72 | printable with the Lisp printer. You don't need to add minibuffer |
| 73 | history variables to this list, all minibuffer histories will be | 73 | history variables to this list, all minibuffer histories will be |
| 74 | saved automatically as long as `savehist-save-minibuffer-history' is | 74 | saved automatically as long as `savehist-save-minibuffer-history' is |
| 75 | non-nil. | 75 | non-nil. |
| 76 | 76 | ||
| 77 | User options should be saved with the customize interface. This | 77 | User options should be saved with the Customize interface. This |
| 78 | list is useful for saving automatically updated variables that are not | 78 | list is useful for saving automatically updated variables that are not |
| 79 | minibuffer histories, such as `compile-command' or `kill-ring'." | 79 | minibuffer histories, such as `compile-command' or `kill-ring'." |
| 80 | :type '(repeat variable) | 80 | :type '(repeat variable) |
| @@ -89,7 +89,7 @@ minibuffer histories, such as `compile-command' or `kill-ring'." | |||
| 89 | (locate-user-emacs-file "history" ".emacs-history") | 89 | (locate-user-emacs-file "history" ".emacs-history") |
| 90 | "File name where minibuffer history is saved to and loaded from. | 90 | "File name where minibuffer history is saved to and loaded from. |
| 91 | The minibuffer history is a series of Lisp expressions loaded | 91 | The minibuffer history is a series of Lisp expressions loaded |
| 92 | automatically when `savehist-mode' is turned on. See `savehist-mode' | 92 | automatically when Savehist mode is turned on. See `savehist-mode' |
| 93 | for more details. | 93 | for more details. |
| 94 | 94 | ||
| 95 | If you want your minibuffer history shared between Emacs and XEmacs, | 95 | If you want your minibuffer history shared between Emacs and XEmacs, |
| @@ -115,14 +115,14 @@ If set to nil, disables timer-based autosaving." | |||
| 115 | :group 'savehist) | 115 | :group 'savehist) |
| 116 | 116 | ||
| 117 | (defcustom savehist-mode-hook nil | 117 | (defcustom savehist-mode-hook nil |
| 118 | "Hook called when `savehist-mode' is turned on." | 118 | "Hook called when Savehist mode is turned on." |
| 119 | :type 'hook | 119 | :type 'hook |
| 120 | :group 'savehist) | 120 | :group 'savehist) |
| 121 | 121 | ||
| 122 | (defcustom savehist-save-hook nil | 122 | (defcustom savehist-save-hook nil |
| 123 | "Hook called by `savehist-save' before saving the variables. | 123 | "Hook called by `savehist-save' before saving the variables. |
| 124 | You can use this hook to influence choice and content of variables to | 124 | You can use this hook to influence choice and content of variables |
| 125 | save." | 125 | to save." |
| 126 | :type 'hook | 126 | :type 'hook |
| 127 | :group 'savehist) | 127 | :group 'savehist) |
| 128 | 128 | ||
| @@ -134,7 +134,7 @@ save." | |||
| 134 | (<= emacs-major-version 21) | 134 | (<= emacs-major-version 21) |
| 135 | (< emacs-minor-version 5)) | 135 | (< emacs-minor-version 5)) |
| 136 | 'iso-2022-8 'utf-8-unix) | 136 | 'iso-2022-8 'utf-8-unix) |
| 137 | "The coding system savehist uses for saving the minibuffer history. | 137 | "The coding system Savehist uses for saving the minibuffer history. |
| 138 | Changing this value while Emacs is running is supported, but considered | 138 | Changing this value while Emacs is running is supported, but considered |
| 139 | unwise, unless you know what you are doing.") | 139 | unwise, unless you know what you are doing.") |
| 140 | 140 | ||
| @@ -158,7 +158,7 @@ buffer text.") | |||
| 158 | 158 | ||
| 159 | (defvar savehist-loaded nil | 159 | (defvar savehist-loaded nil |
| 160 | "Whether the history has already been loaded. | 160 | "Whether the history has already been loaded. |
| 161 | This prevents toggling `savehist-mode' from destroying existing | 161 | This prevents toggling Savehist mode from destroying existing |
| 162 | minibuffer history.") | 162 | minibuffer history.") |
| 163 | 163 | ||
| 164 | (when (featurep 'xemacs) | 164 | (when (featurep 'xemacs) |
| @@ -205,7 +205,7 @@ histories, which is probably undesirable." | |||
| 205 | (savehist-install))) | 205 | (savehist-install))) |
| 206 | 206 | ||
| 207 | (defun savehist-load () | 207 | (defun savehist-load () |
| 208 | "Load the variables stored in `savehist-file' and turn on `savehist-mode'. | 208 | "Load the variables stored in `savehist-file' and turn on Savehist mode. |
| 209 | If `savehist-file' is in the old format that doesn't record | 209 | If `savehist-file' is in the old format that doesn't record |
| 210 | the value of `savehist-minibuffer-history-variables', that | 210 | the value of `savehist-minibuffer-history-variables', that |
| 211 | value is deducted from the contents of the file." | 211 | value is deducted from the contents of the file." |
| @@ -228,7 +228,7 @@ value is deducted from the contents of the file." | |||
| 228 | vars))))) | 228 | vars))))) |
| 229 | 229 | ||
| 230 | (defun savehist-install () | 230 | (defun savehist-install () |
| 231 | "Hook savehist into Emacs. | 231 | "Hook Savehist into Emacs. |
| 232 | Normally invoked by calling `savehist-mode' to set the minor mode. | 232 | Normally invoked by calling `savehist-mode' to set the minor mode. |
| 233 | Installs `savehist-autosave' in `kill-emacs-hook' and on a timer. | 233 | Installs `savehist-autosave' in `kill-emacs-hook' and on a timer. |
| 234 | To undo this, call `savehist-uninstall'." | 234 | To undo this, call `savehist-uninstall'." |
| @@ -356,7 +356,7 @@ If AUTO-SAVE is non-nil, compare the saved contents to the one last saved, | |||
| 356 | 356 | ||
| 357 | (defun savehist-autosave () | 357 | (defun savehist-autosave () |
| 358 | "Save the minibuffer history if it has been modified since the last save. | 358 | "Save the minibuffer history if it has been modified since the last save. |
| 359 | Does nothing if `savehist-mode' is off." | 359 | Does nothing if Savehist mode is off." |
| 360 | (when savehist-mode | 360 | (when savehist-mode |
| 361 | (savehist-save t))) | 361 | (savehist-save t))) |
| 362 | 362 | ||