emacs: lisp/bookmark.el comparison

comparison lisp/bookmark.el @ 7510:9f361177d70c

Doc fixes. (bookmark-relocate): Rename arg.

author	Richard M. Stallman <rms@gnu.org>
date	Mon, 16 May 1994 07:24:45 +0000
parents	cc7cd83ccf3f
children	d1a839615554

comparison

equal deleted inserted replaced

-:dd0db01bc9f4
+:9f361177d70c
 (make-variable-buffer-local 'bookmark-current-bookmark)
 (defvar bookmark-save-flag t
 "*Controls when Emacs saves bookmarks to a file.
---> Nil means never save bookmarks, except when `bookmark-save' is
+--> nil means never save bookmarks, except when `bookmark-save' is
 explicitly called \(\\[bookmark-save]\).
 --> t means save bookmarks when Emacs is killed.
 --> Otherise, it should be a number that is the frequency with which
 the bookmark list is saved \(i.e.: the number of times which
 Emacs' bookmark list may be modified before it is automatically
 (defvar bookmark-file "~/.emacs-bkmrks"
 "*File in which to save bookmarks by default.")
 (defvar bookmark-version-control 'nospecial
-"This variable controls whether or not to make numbered backups of
+"Control whether to make numbered backups of the master bookmark file.
-the master bookmark file.  It can have four values: t, nil, never, and
+This variable can have four values: t, nil, `never', and `nospecial'.
-nospecial.  The first three have the same meaning that they do for the
+The first three have the same meaning that they do for the
-variable version-control, and the final value nospecial means just use
+variable `version-control'.
-the value of version-control.")
+The value `nospecial' means just use the value of `version-control'.")
 (defvar bookmark-completion-ignore-case t
 "*Non-nil means bookmark functions ignore case in completion.")
 (defvar bookmark-sort-flag t
-"*Non-nil means that bookmarks will be displayed sorted by bookmark
+"*Non-nil means display bookmarks sorted by name.
-name.  Otherwise they will be displayed in LIFO order (that is, most
+Otherwise they are  displayed in LIFO order (that is, most
 recently set ones come first, oldest ones come last).")
 (defvar bookmark-search-size 500
 "Length of the context strings recorded on either side of a bookmark.")
 (defvar bookmark-yank-point 0)
 (defvar bookmark-current-buffer nil)
 ;;;###autoload
 (defun bookmark-set (&optional parg)
-"Set a bookmark named NAME inside a file.
+"Set a bookmark named NAME inside the visited file.
 With prefix arg, will not overwrite a bookmark that has the same name
 as NAME if such a bookmark already exists, but instead will \"push\"
 the new bookmark onto the bookmark alist.  Thus the most recently set
 bookmark with name NAME would be the one in effect at any given time,
 but the others are still there, should you decide to delete the most
 To yank words from the text of the buffer and use them as part of the
 bookmark name, type C-w while setting a bookmark.  Successive C-w's
 yank successive words.
-Typing C-v inserts the name of the current file being visited. Typing
+Typing C-v inserts the name of the current file being visited.  Typing
 C-u inserts the name of the last bookmark used in the buffer \(as an
 aid in using a single bookmark name to track your progress through a
 large file\).  If no bookmark was used, then C-u behaves like C-v and
 inserts the name of the file being visited.
 You may have a problem using this function if the value of variable
 `bookmark-alist' is nil.  If that happens, you need to load in some
 bookmarks.  See help on function `bookmark-load' for more about
 this.
-If the file pointed to by BOOKMARK no longer exists, you will be asked
+If the file pointed to by BOOKMARK no longer exists, `bookmark-jump'
-if you wish to give the bookmark a new location, and bookmark-jump
+asks you to specify a different file to use instead.  If you specify
-will then jump to the new location, as well as recording it in place
+one, it also updates BOOKMARK to refer to that file."
-of the old one in the permanent bookmark record."
 (interactive (progn (bookmark-try-default-file)
 (let* ((completion-ignore-case
 bookmark-completion-ignore-case)
 (default
 (or (and
 (message
 "Bookmark not relocated, but deleting it would be a good idea.")
 nil))))))
 ;;;###autoload
-(defun bookmark-relocate (str)
+(defun bookmark-relocate (bookmark)
-"Relocate BOOKMARK -- prompts for a filename, and makes an already
+"Relocate bookmark BOOKMARK.
-existing bookmark point to that file, instead of the one it used to
+Prompt for a filename, and makes the bookmark BOOKMARK point to that
-point at.  Useful when a file has been renamed after a bookmark was
+file, instead of the one it used to point at.  Useful when a file has
-set in it."
+been renamed after a bookmark was set in it."
 (interactive (let ((completion-ignore-case
 bookmark-completion-ignore-case))
 (progn (bookmark-try-default-file)
 (list (completing-read
 "Bookmark to relocate: "
 bookmark-alist
 nil
 0)))))
-(let* ((bmrk (assoc str bookmark-alist))
+(let* ((bmrk (assoc bookmark bookmark-alist))
 (bmrk-filename (car (car (cdr bmrk))))
 (newloc (expand-file-name
 (read-file-name
-(format "Relocate %s to: " str)
+(format "Relocate %s to: " bookmark)
 (file-name-directory bmrk-filename)))))
 (setcar (car (cdr bmrk)) newloc)))
 ;;;###autoload
 (defun bookmark-locate (str &optional no-insertion)
 	(t
 	 nil)))
 ;;;###autoload
 (defun bookmark-write ()
-"Write bookmarks to a file \(for which the user will be prompted
+"Write bookmarks to a specified file.
-interactively\).  Don't use this in Lisp programs; use bookmark-save
+Don't use this in Lisp programs; use `bookmark-save' instead."
-instead."
 (interactive)
 (bookmark-try-default-file)
 (bookmark-save t))
 ;;;###autoload
 ;;;###autoload
 (defun list-bookmarks ()
 "Display a list of existing bookmarks.
 The list is displayed in a buffer named `*Bookmark List*'.
-The leftmost column displays a D if the bookmark is flagged for
+The leftmost column displays a `D' if the bookmark is flagged for
-deletion, or > if it is flagged for displaying."
+deletion, or `>' if it is flagged for displaying."
 (interactive)
 (bookmark-try-default-file)
 (switch-to-buffer (get-buffer-create "*Bookmark List*"))
 (let ((buffer-read-only nil))
 (delete-region (point-max) (point-min))
 Each line describes one of the bookmarks in Emacs.
 Letters do not insert themselves; instead, they are commands.
 \\<Bookmark-menu-mode-map>
 \\[Bookmark-menu-mark] -- mark bookmark to be displayed.
 \\[Bookmark-menu-select] -- select bookmark of line point is on.
-Also show bookmarks marked using m in other windows.
+Also show bookmarks marked using `m' in other windows.
 \\[Bookmark-menu-toggle-filenames] -- toggle displaying of filenames (they may obscure long bookmark names).
 \\[Bookmark-menu-locate] -- display (in minibuffer) location of this bookmark.
 \\[Bookmark-menu-1-window] -- select this bookmark in full-frame window.
 \\[Bookmark-menu-2-window] -- select this bookmark in one window,
 together with bookmark selected before this one in another window.
 (delete-char 1)
 (insert ?D)
 (forward-line 1))))
 (defun Bookmark-menu-delete-backwards ()
-"Mark bookmark on this line to be deleted by \\<Bookmark-menu-mode-map>\\[Bookmark-menu-execute] command
+"Mark bookmark on this line to be deleted by \\<Bookmark-menu-mode-map>\\[Bookmark-menu-execute] command.
-and then move up one line"
+Then move up one line"
 (interactive)
 (Bookmark-menu-delete)
 (forward-line -2)
 (if (Bookmark-menu-check-position)
 (forward-line 1)))
 "--- Jump to Bookmark ---"
 event))
 ;;;###autoload
 (defun bookmark-menu-bar-locate (event)
-"Insert the name of the  file associated with BOOKMARK.
+"Insert the name of the file associated with BOOKMARK.
 \(This is not the same as the contents of that file\)."
 (interactive "e")
 (bookmark-make-menu-bar-with-function 'bookmark-locate
 "Bookmark Locate Menu"
 "--- Insert Location ---"

Mercurial > emacs

comparison lisp/bookmark.el @ 7510:9f361177d70c