diff options
| author | Glenn Morris | 2014-01-26 18:02:28 -0800 |
|---|---|---|
| committer | Glenn Morris | 2014-01-26 18:02:28 -0800 |
| commit | ece4bae50f6ca8d03d076aa33eedd014a3af8c41 (patch) | |
| tree | 66910ffa712f0643475284089989667641d1d5d2 /lisp/shadowfile.el | |
| parent | 6ea71a445d523ff95a2cd6ae0cbde8bd7ca8d878 (diff) | |
| download | emacs-ece4bae50f6ca8d03d076aa33eedd014a3af8c41.tar.gz emacs-ece4bae50f6ca8d03d076aa33eedd014a3af8c41.zip | |
Doc, comment, etc updates for increased use of locate-user-emacs-file
This should have been a prerequisite for making these changes in the
first place.
* doc/emacs/calendar.texi (Time Intervals):
* doc/misc/idlwave.texi (Lesson III---User Catalog, Online Help)
(Starting the Shell, Catalogs, User Catalog):
* doc/misc/remember.texi (Quick Start):
* doc/misc/viper.texi:
* doc/misc/vip.texi (Customization, Customizing Constants)
(Customizing Key Bindings): Update for files being in ~/.emacs.d/.
* lisp/ido.el (ido-save-directory-list-file):
* lisp/saveplace.el (save-place-file):
* lisp/calendar/timeclock.el (timeclock-file):
* lisp/net/quickurl.el (quickurl-url-file):
* lisp/obsolete/otodo-mode.el (todo-file-do, todo-file-done, todo-file-top):
* lisp/progmodes/idlwave.el (idlwave-config-directory):
* lisp/textmodes/remember.el (remember-data-file):
Bump :version.
* lisp/shadowfile.el (shadow-info-file, shadow-todo-file): Doc fix.
* lisp/strokes.el (strokes-file): Doc fix. Bump :version.
(strokes-help): Doc fix.
* lisp/emulation/viper-init.el (viper-vi-style-in-minibuffer): Doc fix.
* lisp/emulation/viper.el (viper): Doc fix for custom group.
(top-level): Remove oh-so-no-longer-relevant text about vip.
* lisp/obsolete/otodo-mode.el (todo-prefix): Doc fix.
* etc/NEWS: Related edits.
Diffstat (limited to 'lisp/shadowfile.el')
| -rw-r--r-- | lisp/shadowfile.el | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/lisp/shadowfile.el b/lisp/shadowfile.el index d409d5672f5..2bf200d07dd 100644 --- a/lisp/shadowfile.el +++ b/lisp/shadowfile.el | |||
| @@ -34,21 +34,22 @@ | |||
| 34 | ;; documentation for these functions for information on how and when to use | 34 | ;; documentation for these functions for information on how and when to use |
| 35 | ;; them). After doing this once, everything should be automatic. | 35 | ;; them). After doing this once, everything should be automatic. |
| 36 | 36 | ||
| 37 | ;; The lists of clusters and shadows are saved in a file called .shadows, | 37 | ;; The lists of clusters and shadows are saved in a ~/.emacs.d/shadows |
| 38 | ;; so that they can be remembered from one Emacs session to another, even | 38 | ;; (`shadow-info-file') file, so that they can be remembered from one |
| 39 | ;; (as much as possible) if the Emacs session terminates abnormally. The | 39 | ;; Emacs session to another, even (as much as possible) if the Emacs |
| 40 | ;; files needing to be copied are stored in .shadow_todo; if a file cannot | 40 | ;; session terminates abnormally. The files needing to be copied are |
| 41 | ;; be copied for any reason, it will stay on the list to be tried again | 41 | ;; stored in `shadow-todo-file'; if a file cannot be copied for any |
| 42 | ;; next time. The .shadows file should itself have shadows on all your | 42 | ;; reason, it will stay on the list to be tried again next time. The |
| 43 | ;; accounts so that the information in it is consistent everywhere, but | 43 | ;; `shadow-info-file' file should itself have shadows on all your accounts |
| 44 | ;; .shadow_todo is local information and should have no shadows. | 44 | ;; so that the information in it is consistent everywhere, but |
| 45 | ;; `shadow-todo-file' is local information and should have no shadows. | ||
| 45 | 46 | ||
| 46 | ;; If you do not want to copy a particular file, you can answer "no" and | 47 | ;; If you do not want to copy a particular file, you can answer "no" and |
| 47 | ;; be asked again next time you hit C-x 4 s or exit Emacs. If you do not | 48 | ;; be asked again next time you hit C-x 4 s or exit Emacs. If you do not |
| 48 | ;; want to be asked again, use shadow-cancel, and you will not be asked | 49 | ;; want to be asked again, use shadow-cancel, and you will not be asked |
| 49 | ;; until you change the file and save it again. If you do not want to | 50 | ;; until you change the file and save it again. If you do not want to |
| 50 | ;; shadow that file ever again, you can edit it out of the .shadows | 51 | ;; shadow that file ever again, you can edit it out of the shadows |
| 51 | ;; buffer. Anytime you edit the .shadows buffer, you must type M-x | 52 | ;; buffer. Anytime you edit the shadows buffer, you must type M-x |
| 52 | ;; shadow-read-files to load in the new information, or your changes will | 53 | ;; shadow-read-files to load in the new information, or your changes will |
| 53 | ;; be overwritten! | 54 | ;; be overwritten! |
| 54 | 55 | ||
| @@ -106,10 +107,13 @@ files that have been changed and need to be copied to other systems." | |||
| 106 | :type 'boolean | 107 | :type 'boolean |
| 107 | :group 'shadow) | 108 | :group 'shadow) |
| 108 | 109 | ||
| 110 | ;; FIXME in a sense, this changed in 24.4 (addition of locate-user-emacs-file), | ||
| 111 | ;; but due to the weird way this variable is initialized to nil, it didn't | ||
| 112 | ;; literally change. Same for shadow-todo-file. | ||
| 109 | (defcustom shadow-info-file nil | 113 | (defcustom shadow-info-file nil |
| 110 | "File to keep shadow information in. | 114 | "File to keep shadow information in. |
| 111 | The `shadow-info-file' should be shadowed to all your accounts to | 115 | The `shadow-info-file' should be shadowed to all your accounts to |
| 112 | ensure consistency. Default: ~/.shadows" | 116 | ensure consistency. Default: ~/.emacs.d/shadows" |
| 113 | :type '(choice (const nil) file) | 117 | :type '(choice (const nil) file) |
| 114 | :group 'shadow) | 118 | :group 'shadow) |
| 115 | 119 | ||
| @@ -119,7 +123,7 @@ This means that if a remote system is down, or for any reason you cannot or | |||
| 119 | decide not to copy your shadow files at the end of one Emacs session, it will | 123 | decide not to copy your shadow files at the end of one Emacs session, it will |
| 120 | remember and ask you again in your next Emacs session. | 124 | remember and ask you again in your next Emacs session. |
| 121 | This file must NOT be shadowed to any other system, it is host-specific. | 125 | This file must NOT be shadowed to any other system, it is host-specific. |
| 122 | Default: ~/.shadow_todo" | 126 | Default: ~/.emacs.d/shadow_todo" |
| 123 | :type '(choice (const nil) file) | 127 | :type '(choice (const nil) file) |
| 124 | :group 'shadow) | 128 | :group 'shadow) |
| 125 | 129 | ||