diff options
| author | Stefan Monnier | 2007-07-18 19:16:41 +0000 |
|---|---|---|
| committer | Stefan Monnier | 2007-07-18 19:16:41 +0000 |
| commit | e725d58ffd318c662c434e0a74b2fc00fed43f6b (patch) | |
| tree | a612123d734a9adc43d73530d170c1496dbc94f0 | |
| parent | 8cdd17b444075b04fbe47ffd8ee4cf0e617e4f42 (diff) | |
| download | emacs-e725d58ffd318c662c434e0a74b2fc00fed43f6b.tar.gz emacs-e725d58ffd318c662c434e0a74b2fc00fed43f6b.zip | |
Docstring fixes.
| -rw-r--r-- | lisp/ChangeLog | 4 | ||||
| -rw-r--r-- | lisp/uniquify.el | 20 |
2 files changed, 15 insertions, 9 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index cda784aa7a9..a587585ce0e 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2007-07-18 Stefan Monnier <monnier@iro.umontreal.ca> | ||
| 2 | |||
| 3 | * uniquify.el: Docstring fixes. | ||
| 4 | |||
| 1 | 2007-07-18 Eric S. Raymond <esr@snark.thyrsus.com> | 5 | 2007-07-18 Eric S. Raymond <esr@snark.thyrsus.com> |
| 2 | 6 | ||
| 3 | * vc-hooks.el: Generalize stay-local-p to operate on lists of | 7 | * vc-hooks.el: Generalize stay-local-p to operate on lists of |
diff --git a/lisp/uniquify.el b/lisp/uniquify.el index d79add6899f..c8bbd9256bd 100644 --- a/lisp/uniquify.el +++ b/lisp/uniquify.el | |||
| @@ -28,7 +28,7 @@ | |||
| 28 | ;;; Commentary: | 28 | ;;; Commentary: |
| 29 | 29 | ||
| 30 | ;; Emacs's standard method for making buffer names unique adds <2>, <3>, | 30 | ;; Emacs's standard method for making buffer names unique adds <2>, <3>, |
| 31 | ;; etc. to the end of (all but one of) the buffers. This file replaces | 31 | ;; etc.. to the end of (all but one of) the buffers. This file replaces |
| 32 | ;; that behavior, for buffers visiting files and dired buffers, with a | 32 | ;; that behavior, for buffers visiting files and dired buffers, with a |
| 33 | ;; uniquification that adds parts of the file name until the buffer names | 33 | ;; uniquification that adds parts of the file name until the buffer names |
| 34 | ;; are unique. For instance, buffers visiting /u/mernst/tmp/Makefile and | 34 | ;; are unique. For instance, buffers visiting /u/mernst/tmp/Makefile and |
| @@ -95,7 +95,7 @@ | |||
| 95 | 95 | ||
| 96 | 96 | ||
| 97 | (defcustom uniquify-buffer-name-style nil | 97 | (defcustom uniquify-buffer-name-style nil |
| 98 | "*If non-nil, buffer names are uniquified with parts of directory name. | 98 | "If non-nil, buffer names are uniquified with parts of directory name. |
| 99 | The value determines the buffer name style and is one of `forward', | 99 | The value determines the buffer name style and is one of `forward', |
| 100 | `reverse', `post-forward', or `post-forward-angle-brackets'. | 100 | `reverse', `post-forward', or `post-forward-angle-brackets'. |
| 101 | For example, files `/foo/bar/mumble/name' and `/baz/quux/mumble/name' | 101 | For example, files `/foo/bar/mumble/name' and `/baz/quux/mumble/name' |
| @@ -104,7 +104,9 @@ would have the following buffer names in the various styles: | |||
| 104 | reverse name\\mumble\\bar name\\mumble\\quux | 104 | reverse name\\mumble\\bar name\\mumble\\quux |
| 105 | post-forward name|bar/mumble name|quux/mumble | 105 | post-forward name|bar/mumble name|quux/mumble |
| 106 | post-forward-angle-brackets name<bar/mumble> name<quux/mumble> | 106 | post-forward-angle-brackets name<bar/mumble> name<quux/mumble> |
| 107 | nil name name<2>" | 107 | nil name name<2> |
| 108 | Of course, the \"mumble\" part may be stripped as well, depending on the setting | ||
| 109 | of `uniquify-strip-common-suffix'." | ||
| 108 | :type '(radio (const forward) | 110 | :type '(radio (const forward) |
| 109 | (const reverse) | 111 | (const reverse) |
| 110 | (const post-forward) | 112 | (const post-forward) |
| @@ -119,7 +121,7 @@ would have the following buffer names in the various styles: | |||
| 119 | :group 'uniquify) | 121 | :group 'uniquify) |
| 120 | 122 | ||
| 121 | (defcustom uniquify-ask-about-buffer-names-p nil | 123 | (defcustom uniquify-ask-about-buffer-names-p nil |
| 122 | "*If non-nil, permit user to choose names for buffers with same base file. | 124 | "If non-nil, permit user to choose names for buffers with same base file. |
| 123 | If the user chooses to name a buffer, uniquification is preempted and no | 125 | If the user chooses to name a buffer, uniquification is preempted and no |
| 124 | other buffer names are changed." | 126 | other buffer names are changed." |
| 125 | :type 'boolean | 127 | :type 'boolean |
| @@ -127,7 +129,7 @@ other buffer names are changed." | |||
| 127 | 129 | ||
| 128 | ;; The default value matches certain Gnus buffers. | 130 | ;; The default value matches certain Gnus buffers. |
| 129 | (defcustom uniquify-ignore-buffers-re nil | 131 | (defcustom uniquify-ignore-buffers-re nil |
| 130 | "*Regular expression matching buffer names that should not be uniquified. | 132 | "Regular expression matching buffer names that should not be uniquified. |
| 131 | For instance, set this to \"^draft-[0-9]+$\" to avoid having uniquify rename | 133 | For instance, set this to \"^draft-[0-9]+$\" to avoid having uniquify rename |
| 132 | draft buffers even if `uniquify-after-kill-buffer-p' is non-nil and the | 134 | draft buffers even if `uniquify-after-kill-buffer-p' is non-nil and the |
| 133 | visited file name isn't the same as that of the buffer." | 135 | visited file name isn't the same as that of the buffer." |
| @@ -135,12 +137,12 @@ visited file name isn't the same as that of the buffer." | |||
| 135 | :group 'uniquify) | 137 | :group 'uniquify) |
| 136 | 138 | ||
| 137 | (defcustom uniquify-min-dir-content 0 | 139 | (defcustom uniquify-min-dir-content 0 |
| 138 | "*Minimum number of directory name components included in buffer name." | 140 | "Minimum number of directory name components included in buffer name." |
| 139 | :type 'integer | 141 | :type 'integer |
| 140 | :group 'uniquify) | 142 | :group 'uniquify) |
| 141 | 143 | ||
| 142 | (defcustom uniquify-separator nil | 144 | (defcustom uniquify-separator nil |
| 143 | "*String separator for buffer name components. | 145 | "String separator for buffer name components. |
| 144 | When `uniquify-buffer-name-style' is `post-forward', separates | 146 | When `uniquify-buffer-name-style' is `post-forward', separates |
| 145 | base file name from directory part in buffer names (default \"|\"). | 147 | base file name from directory part in buffer names (default \"|\"). |
| 146 | When `uniquify-buffer-name-style' is `reverse', separates all | 148 | When `uniquify-buffer-name-style' is `reverse', separates all |
| @@ -149,7 +151,7 @@ file name components (default \"\\\")." | |||
| 149 | :group 'uniquify) | 151 | :group 'uniquify) |
| 150 | 152 | ||
| 151 | (defcustom uniquify-trailing-separator-p nil | 153 | (defcustom uniquify-trailing-separator-p nil |
| 152 | "*If non-nil, add a file name separator to dired buffer names. | 154 | "If non-nil, add a file name separator to dired buffer names. |
| 153 | If `uniquify-buffer-name-style' is `forward', add the separator at the end; | 155 | If `uniquify-buffer-name-style' is `forward', add the separator at the end; |
| 154 | if it is `reverse', add the separator at the beginning; otherwise, this | 156 | if it is `reverse', add the separator at the beginning; otherwise, this |
| 155 | variable is ignored." | 157 | variable is ignored." |
| @@ -255,7 +257,7 @@ in `uniquify-list-buffers-directory-modes', otherwise returns nil." | |||
| 255 | (directory-file-name filename)))))))) | 257 | (directory-file-name filename)))))))) |
| 256 | 258 | ||
| 257 | (defun uniquify-rerationalize-w/o-cb (fix-list) | 259 | (defun uniquify-rerationalize-w/o-cb (fix-list) |
| 258 | "Re-rationalize the buffers in FIX-LIST, but ignoring current-buffer." | 260 | "Re-rationalize the buffers in FIX-LIST, but ignoring `current-buffer'." |
| 259 | (let ((new-fix-list nil)) | 261 | (let ((new-fix-list nil)) |
| 260 | (dolist (item fix-list) | 262 | (dolist (item fix-list) |
| 261 | (let ((buf (uniquify-item-buffer item))) | 263 | (let ((buf (uniquify-item-buffer item))) |