[Emacs-diffs] emacs/lisp bookmark.el ChangeLog

[Karl Fogel]

CVSROOT:        /sources/emacs
Module name:    emacs
Changes by:     Karl Fogel <kfogel>     09/10/05 01:47:03

Modified files:
        lisp           : bookmark.el ChangeLog 

Log message:
        * bookmark.el (bookmark-set, bookmark-buffer-name): Improve doc strings.
          (Bug#1193)

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/emacs/lisp/bookmark.el?cvsroot=emacs&r1=1.128&r2=1.129
http://cvs.savannah.gnu.org/viewcvs/emacs/lisp/ChangeLog?cvsroot=emacs&r1=1.16354&r2=1.16355

Patches:
Index: bookmark.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/bookmark.el,v
retrieving revision 1.128
retrieving revision 1.129
diff -u -b -r1.128 -r1.129
--- bookmark.el 5 Oct 2009 01:35:34 -0000       1.128
+++ bookmark.el 5 Oct 2009 01:47:00 -0000       1.129
@@ -733,13 +733,13 @@
 
 ;;;###autoload
 (defun bookmark-set (&optional name no-overwrite)
-  "Set a bookmark named NAME inside a file.
+  "Set a bookmark named NAME at the current location.
 If name is nil, then prompt the user.
 
 With prefix arg (NO-OVERWRITE), do not overwrite a bookmark that
 has the same name as NAME if such a bookmark already exists, but
-instead \"push\" the new bookmark onto the bookmark alist.  Thus
-the most recently set bookmark with name NAME would be the one in
+instead 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
 the user decide to delete the most recent one.
 
@@ -747,10 +747,11 @@
 bookmark name, type C-w while setting a bookmark.  Successive C-w's
 yank successive words.
 
-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 progress through
-a large file\).  If no bookmark was used, then C-u inserts the name of
-the file being visited.
+Typing C-u will insert (at the bookmark name prompt) the name of the
+last bookmark used in the document where the new bookmark is being set;
+this helps one use a single bookmark name to track progress through
+a large document.  If there is no prior bookmark for this document,
+then C-u inserts an appropriate name based on the buffer or file.
 
 Use \\[bookmark-delete] to remove bookmarks \(give it a name and it
 removes only the first instance of a bookmark with that name from
@@ -883,7 +884,8 @@
 
 
 (defun bookmark-buffer-name ()
-  "Return the name of the current buffer's file, non-directory."
+  "Return the name of the current buffer (or its file, if any) in a
+way that is suitable as a bookmark name."
   (cond
    ;; Or are we a file?
    (buffer-file-name (file-name-nondirectory buffer-file-name))

Index: ChangeLog
===================================================================
RCS file: /sources/emacs/emacs/lisp/ChangeLog,v
retrieving revision 1.16354
retrieving revision 1.16355
diff -u -b -r1.16354 -r1.16355
--- ChangeLog   5 Oct 2009 01:35:35 -0000       1.16354
+++ ChangeLog   5 Oct 2009 01:47:00 -0000       1.16355
@@ -1,5 +1,10 @@
 2009-10-04  Karl Fogel  <address@hidden>
 
+       * bookmark.el (bookmark-set, bookmark-buffer-name):
+       Improve doc strings.  (Bug#1193)
+
+2009-10-04  Karl Fogel  <address@hidden>
+
        * bookmark.el (bookmark-get-bookmark, bookmark-get-bookmark-record,
         bookmark-set-name, bookmark-prop-get, bookmark-prop-set,
         bookmark-get-annotation, bookmark-set-annotation,