diff options
| author | Juanma Barranquero | 2010-01-02 02:05:44 +0100 |
|---|---|---|
| committer | Juanma Barranquero | 2010-01-02 02:05:44 +0100 |
| commit | 0472835ff2f73013a9633306bf60faa49cd777ba (patch) | |
| tree | ff0ede67f53f653b2cced21bf79cc30080c144d7 /lisp/bookmark.el | |
| parent | db4a7382f0ee49338f9c52adb93cd16c4b93dcd3 (diff) | |
| download | emacs-0472835ff2f73013a9633306bf60faa49cd777ba.tar.gz emacs-0472835ff2f73013a9633306bf60faa49cd777ba.zip | |
lisp/*: Fix typos in docstrings and messages.
Diffstat (limited to 'lisp/bookmark.el')
| -rw-r--r-- | lisp/bookmark.el | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/lisp/bookmark.el b/lisp/bookmark.el index 4614eef493d..54a70621cf9 100644 --- a/lisp/bookmark.el +++ b/lisp/bookmark.el | |||
| @@ -107,17 +107,17 @@ | |||
| 107 | (defcustom bookmark-save-flag t | 107 | (defcustom bookmark-save-flag t |
| 108 | "Controls when Emacs saves bookmarks to a file. | 108 | "Controls when Emacs saves bookmarks to a file. |
| 109 | --> nil means never save bookmarks, except when `bookmark-save' is | 109 | --> nil means never save bookmarks, except when `bookmark-save' is |
| 110 | explicitly called \(\\[bookmark-save]\). | 110 | explicitly called (\\[bookmark-save]). |
| 111 | --> t means save bookmarks when Emacs is killed. | 111 | --> t means save bookmarks when Emacs is killed. |
| 112 | --> Otherwise, it should be a number that is the frequency with which | 112 | --> Otherwise, it should be a number that is the frequency with which |
| 113 | the bookmark list is saved \(i.e.: the number of times which | 113 | the bookmark list is saved (i.e.: the number of times which |
| 114 | Emacs' bookmark list may be modified before it is automatically | 114 | Emacs' bookmark list may be modified before it is automatically |
| 115 | saved.\). If it is a number, Emacs will also automatically save | 115 | saved.). If it is a number, Emacs will also automatically save |
| 116 | bookmarks when it is killed. | 116 | bookmarks when it is killed. |
| 117 | 117 | ||
| 118 | Therefore, the way to get it to save every time you make or delete a | 118 | Therefore, the way to get it to save every time you make or delete a |
| 119 | bookmark is to set this variable to 1 \(or 0, which produces the same | 119 | bookmark is to set this variable to 1 (or 0, which produces the same |
| 120 | behavior.\) | 120 | behavior.) |
| 121 | 121 | ||
| 122 | To specify the file in which to save them, modify the variable | 122 | To specify the file in which to save them, modify the variable |
| 123 | `bookmark-default-file', which is `~/.emacs.bmk' by default." | 123 | `bookmark-default-file', which is `~/.emacs.bmk' by default." |
| @@ -186,7 +186,7 @@ You can toggle whether files are shown with \\<bookmark-bmenu-mode-map>\\[bookma | |||
| 186 | This may result in truncated bookmark names. To disable this, put the | 186 | This may result in truncated bookmark names. To disable this, put the |
| 187 | following in your `.emacs' file: | 187 | following in your `.emacs' file: |
| 188 | 188 | ||
| 189 | \(setq bookmark-bmenu-toggle-filenames nil\)" | 189 | \(setq bookmark-bmenu-toggle-filenames nil)" |
| 190 | :type 'boolean | 190 | :type 'boolean |
| 191 | :group 'bookmark) | 191 | :group 'bookmark) |
| 192 | 192 | ||
| @@ -292,7 +292,7 @@ or the deprecated form (BOOKMARK-NAME PARAM-ALIST). | |||
| 292 | for instance. HANDLER must accept a bookmark as argument.") | 292 | for instance. HANDLER must accept a bookmark as argument.") |
| 293 | 293 | ||
| 294 | (defvar bookmarks-already-loaded nil | 294 | (defvar bookmarks-already-loaded nil |
| 295 | "Non-nil iff bookmarks have been loaded from `bookmark-default-file'.") | 295 | "Non-nil if and only if bookmarks have been loaded from `bookmark-default-file'.") |
| 296 | 296 | ||
| 297 | 297 | ||
| 298 | ;; more stuff added by db. | 298 | ;; more stuff added by db. |
| @@ -322,7 +322,7 @@ the source buffer for that information; see `bookmark-yank-word' and | |||
| 322 | 322 | ||
| 323 | (defvar bookmark-yank-point 0 | 323 | (defvar bookmark-yank-point 0 |
| 324 | "The next point from which to pull source text for `bookmark-yank-word'. | 324 | "The next point from which to pull source text for `bookmark-yank-word'. |
| 325 | This point is in `bookmark-curent-buffer'.") | 325 | This point is in `bookmark-current-buffer'.") |
| 326 | 326 | ||
| 327 | 327 | ||
| 328 | (defvar bookmark-quit-flag nil | 328 | (defvar bookmark-quit-flag nil |
| @@ -336,7 +336,7 @@ This point is in `bookmark-curent-buffer'.") | |||
| 336 | 336 | ||
| 337 | 337 | ||
| 338 | (defun bookmark-name-from-full-record (full-record) | 338 | (defun bookmark-name-from-full-record (full-record) |
| 339 | "Return name of FULL-RECORD \(an alist element instead of a string\)." | 339 | "Return name of FULL-RECORD (an alist element instead of a string)." |
| 340 | (car full-record)) | 340 | (car full-record)) |
| 341 | 341 | ||
| 342 | 342 | ||
| @@ -414,13 +414,13 @@ BOOKMARK may be a bookmark name (a string) or a bookmark record." | |||
| 414 | 414 | ||
| 415 | 415 | ||
| 416 | (defun bookmark-get-position (bookmark) | 416 | (defun bookmark-get-position (bookmark) |
| 417 | "Return the position \(i.e.: point\) of BOOKMARK, or nil if none. | 417 | "Return the position (i.e.: point) of BOOKMARK, or nil if none. |
| 418 | BOOKMARK may be a bookmark name (a string) or a bookmark record." | 418 | BOOKMARK may be a bookmark name (a string) or a bookmark record." |
| 419 | (bookmark-prop-get bookmark 'position)) | 419 | (bookmark-prop-get bookmark 'position)) |
| 420 | 420 | ||
| 421 | 421 | ||
| 422 | (defun bookmark-set-position (bookmark position) | 422 | (defun bookmark-set-position (bookmark position) |
| 423 | "Set the position \(i.e.: point\) of BOOKMARK to POSITION. | 423 | "Set the position (i.e.: point) of BOOKMARK to POSITION. |
| 424 | BOOKMARK may be a bookmark name (a string) or a bookmark record." | 424 | BOOKMARK may be a bookmark name (a string) or a bookmark record." |
| 425 | (bookmark-prop-set bookmark 'position position)) | 425 | (bookmark-prop-set bookmark 'position position)) |
| 426 | 426 | ||
| @@ -800,9 +800,9 @@ this helps you use a single bookmark name to track progress through a | |||
| 800 | large document. If there is no prior bookmark for this document, then | 800 | large document. If there is no prior bookmark for this document, then |
| 801 | C-u inserts an appropriate name based on the buffer or file. | 801 | C-u inserts an appropriate name based on the buffer or file. |
| 802 | 802 | ||
| 803 | Use \\[bookmark-delete] to remove bookmarks \(you give it a name and | 803 | Use \\[bookmark-delete] to remove bookmarks (you give it a name and |
| 804 | it removes only the first instance of a bookmark with that name from | 804 | it removes only the first instance of a bookmark with that name from |
| 805 | the list of bookmarks.\)" | 805 | the list of bookmarks.)" |
| 806 | (interactive (list nil current-prefix-arg)) | 806 | (interactive (list nil current-prefix-arg)) |
| 807 | (let* ((record (bookmark-make-record)) | 807 | (let* ((record (bookmark-make-record)) |
| 808 | (default (car record))) | 808 | (default (car record))) |
| @@ -953,7 +953,7 @@ If the buffer is associated with a file or directory, use that name." | |||
| 953 | (defun bookmark-yank-word () | 953 | (defun bookmark-yank-word () |
| 954 | "Get the next word from buffer `bookmark-current-buffer' and append | 954 | "Get the next word from buffer `bookmark-current-buffer' and append |
| 955 | it to the name of the bookmark currently being set, advancing | 955 | it to the name of the bookmark currently being set, advancing |
| 956 | `bookmark-yank-point' by one word." | 956 | `bookmark-yank-point' by one word." |
| 957 | (interactive) | 957 | (interactive) |
| 958 | (let ((string (with-current-buffer bookmark-current-buffer | 958 | (let ((string (with-current-buffer bookmark-current-buffer |
| 959 | (goto-char bookmark-yank-point) | 959 | (goto-char bookmark-yank-point) |
| @@ -1125,7 +1125,7 @@ that file no longer exists, then offer interactively to relocate BOOKMARK." | |||
| 1125 | 'bookmark-default-handler) | 1125 | 'bookmark-default-handler) |
| 1126 | (bookmark-get-bookmark bookmark))) | 1126 | (bookmark-get-bookmark bookmark))) |
| 1127 | (message | 1127 | (message |
| 1128 | "Bookmark not relocated; consider removing it \(%s\)." | 1128 | "Bookmark not relocated; consider removing it (%s)." |
| 1129 | bookmark) | 1129 | bookmark) |
| 1130 | (signal (car err) (cdr err)))))))))) | 1130 | (signal (car err) (cdr err)))))))))) |
| 1131 | ;; Added by db. | 1131 | ;; Added by db. |
| @@ -1248,7 +1248,7 @@ name." | |||
| 1248 | "New name: " | 1248 | "New name: " |
| 1249 | nil | 1249 | nil |
| 1250 | (let ((now-map (copy-keymap minibuffer-local-map))) | 1250 | (let ((now-map (copy-keymap minibuffer-local-map))) |
| 1251 | (define-key now-map "\C-w" 'bookmark-yank-word) | 1251 | (define-key now-map "\C-w" 'bookmark-yank-word) |
| 1252 | now-map) | 1252 | now-map) |
| 1253 | nil | 1253 | nil |
| 1254 | 'bookmark-history)))) | 1254 | 'bookmark-history)))) |
| @@ -1290,8 +1290,8 @@ BOOKMARK is a bookmark name (a string), not a bookmark record. | |||
| 1290 | 1290 | ||
| 1291 | Removes only the first instance of a bookmark with that name. If | 1291 | Removes only the first instance of a bookmark with that name. If |
| 1292 | there are one or more other bookmarks with the same name, they will | 1292 | there are one or more other bookmarks with the same name, they will |
| 1293 | not be deleted. Defaults to the \"current\" bookmark \(that is, the | 1293 | not be deleted. Defaults to the \"current\" bookmark (that is, the |
| 1294 | one most recently used in this file, if any\). | 1294 | one most recently used in this file, if any). |
| 1295 | Optional second arg BATCH means don't update the bookmark list buffer, | 1295 | Optional second arg BATCH means don't update the bookmark list buffer, |
| 1296 | probably because we were called from there." | 1296 | probably because we were called from there." |
| 1297 | (interactive | 1297 | (interactive |
| @@ -1342,7 +1342,7 @@ Don't use this in Lisp programs; use `bookmark-save' instead." | |||
| 1342 | "Save currently defined bookmarks. | 1342 | "Save currently defined bookmarks. |
| 1343 | Saves by default in the file defined by the variable | 1343 | Saves by default in the file defined by the variable |
| 1344 | `bookmark-default-file'. With a prefix arg, save it in file FILE | 1344 | `bookmark-default-file'. With a prefix arg, save it in file FILE |
| 1345 | \(second argument\). | 1345 | \(second argument). |
| 1346 | 1346 | ||
| 1347 | If you are calling this from Lisp, the two arguments are PARG and | 1347 | If you are calling this from Lisp, the two arguments are PARG and |
| 1348 | FILE, and if you just want it to write to the default file, then | 1348 | FILE, and if you just want it to write to the default file, then |
| @@ -1351,7 +1351,7 @@ instead. If you pass in one argument, and it is non-nil, then the | |||
| 1351 | user will be interactively queried for a file to save in. | 1351 | user will be interactively queried for a file to save in. |
| 1352 | 1352 | ||
| 1353 | When you want to load in the bookmarks from a file, use | 1353 | When you want to load in the bookmarks from a file, use |
| 1354 | \`bookmark-load\', \\[bookmark-load]. That function will prompt you | 1354 | `bookmark-load', \\[bookmark-load]. That function will prompt you |
| 1355 | for a file, defaulting to the file defined by variable | 1355 | for a file, defaulting to the file defined by variable |
| 1356 | `bookmark-default-file'." | 1356 | `bookmark-default-file'." |
| 1357 | (interactive "P") | 1357 | (interactive "P") |
| @@ -1389,7 +1389,7 @@ for a file, defaulting to the file defined by variable | |||
| 1389 | ;; Rather than a single call to `pp' we make one per bookmark. | 1389 | ;; Rather than a single call to `pp' we make one per bookmark. |
| 1390 | ;; Apparently `pp' has a poor algorithmic complexity, so this | 1390 | ;; Apparently `pp' has a poor algorithmic complexity, so this |
| 1391 | ;; scales a lot better. bug#4485. | 1391 | ;; scales a lot better. bug#4485. |
| 1392 | (dolist (i bookmark-alist) (pp i (current-buffer))) | 1392 | (dolist (i bookmark-alist) (pp i (current-buffer))) |
| 1393 | (insert ")") | 1393 | (insert ")") |
| 1394 | (let ((version-control | 1394 | (let ((version-control |
| 1395 | (cond | 1395 | (cond |
| @@ -1625,8 +1625,8 @@ Bookmark names preceded by a \"*\" have annotations. | |||
| 1625 | \\[bookmark-bmenu-other-window] -- select this bookmark in another window, | 1625 | \\[bookmark-bmenu-other-window] -- select this bookmark in another window, |
| 1626 | so the bookmark menu bookmark remains visible in its window. | 1626 | so the bookmark menu bookmark remains visible in its window. |
| 1627 | \\[bookmark-bmenu-switch-other-window] -- switch the other window to this bookmark. | 1627 | \\[bookmark-bmenu-switch-other-window] -- switch the other window to this bookmark. |
| 1628 | \\[bookmark-bmenu-rename] -- rename this bookmark \(prompts for new name\). | 1628 | \\[bookmark-bmenu-rename] -- rename this bookmark (prompts for new name). |
| 1629 | \\[bookmark-bmenu-relocate] -- relocate this bookmark's file \(prompts for new file\). | 1629 | \\[bookmark-bmenu-relocate] -- relocate this bookmark's file (prompts for new file). |
| 1630 | \\[bookmark-bmenu-delete] -- mark this bookmark to be deleted, and move down. | 1630 | \\[bookmark-bmenu-delete] -- mark this bookmark to be deleted, and move down. |
| 1631 | \\[bookmark-bmenu-delete-backwards] -- mark this bookmark to be deleted, and move up. | 1631 | \\[bookmark-bmenu-delete-backwards] -- mark this bookmark to be deleted, and move up. |
| 1632 | \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'. | 1632 | \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'. |
| @@ -1731,7 +1731,7 @@ mainly for debugging, and should not be necessary in normal use." | |||
| 1731 | "If point is not on a bookmark line, move it to one. | 1731 | "If point is not on a bookmark line, move it to one. |
| 1732 | If before the first bookmark line, move it to the first. | 1732 | If before the first bookmark line, move it to the first. |
| 1733 | If after the last, move it to the last. | 1733 | If after the last, move it to the last. |
| 1734 | Return `bookmark-alist'" | 1734 | Return `bookmark-alist'." |
| 1735 | ;; FIXME: The doc string originally implied that this returns nil if | 1735 | ;; FIXME: The doc string originally implied that this returns nil if |
| 1736 | ;; not on a bookmark, which is false. Is there any real reason to | 1736 | ;; not on a bookmark, which is false. Is there any real reason to |
| 1737 | ;; return `bookmark-alist'? This seems to be called in a few places | 1737 | ;; return `bookmark-alist'? This seems to be called in a few places |
| @@ -2101,7 +2101,7 @@ To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\ | |||
| 2101 | (when bookmark-quit-flag ; C-g hit restore menu list. | 2101 | (when bookmark-quit-flag ; C-g hit restore menu list. |
| 2102 | (bookmark-bmenu-list) (bookmark-bmenu-goto-bookmark bmk)) | 2102 | (bookmark-bmenu-list) (bookmark-bmenu-goto-bookmark bmk)) |
| 2103 | (setq bookmark-quit-flag nil)))) | 2103 | (setq bookmark-quit-flag nil)))) |
| 2104 | 2104 | ||
| 2105 | (defun bookmark-bmenu-goto-bookmark (name) | 2105 | (defun bookmark-bmenu-goto-bookmark (name) |
| 2106 | "Move point to bookmark with name NAME." | 2106 | "Move point to bookmark with name NAME." |
| 2107 | (goto-char (point-min)) | 2107 | (goto-char (point-min)) |
| @@ -2109,7 +2109,7 @@ To carry out the deletions that you've marked, use \\<bookmark-bmenu-mode-map>\\ | |||
| 2109 | (while (not (equal name (bookmark-bmenu-bookmark))) | 2109 | (while (not (equal name (bookmark-bmenu-bookmark))) |
| 2110 | (forward-line 1)) | 2110 | (forward-line 1)) |
| 2111 | (forward-line 0)) | 2111 | (forward-line 0)) |
| 2112 | 2112 | ||
| 2113 | 2113 | ||
| 2114 | 2114 | ||
| 2115 | ;;; Menu bar stuff. Prefix is "bookmark-menu". | 2115 | ;;; Menu bar stuff. Prefix is "bookmark-menu". |