GNU bug report logs - #4195
23.1; bookmark-alist and bookmark doc about structure

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (Emacs bug Tracking System)
To: Karl Fogel <kfogel <at> red-bean.com>
Subject: bug#4195: marked as done (23.1; bookmark-alist and bookmark doc
 about structure)
Date: Sun, 25 Oct 2009 02:20:05 +0000

[Message part 1 (text/plain, inline)]

Your message dated Sat, 24 Oct 2009 22:11:39 -0400
with message-id <871vksdxyc.fsf <at> red-bean.com>
and subject line Fix "bookmark-alist and bookmark doc about structure"
has caused the Emacs bug report #4195,
regarding 23.1; bookmark-alist and bookmark doc about structure
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact help-debbugs <at> gnu.org
immediately.)


-- 
4195: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=4195
Emacs Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 23.1; bookmark-alist and bookmark doc about structure
Date: Tue, 18 Aug 2009 15:04:20 -0700

emacs -Q
 
I think there is a doc bug regarding the descriptions of the structure
of `bookmark-alist'.
 
From the doc string of `bookmark-alist':
 
 PARAM-ALIST is typically of the form:
 
 ((filename . FILE)
  (front-context-string . FRONT-STR)
  (rear-context-string  . REAR-STR)
  (position . POS)
  (annotation . ANNOTATION)))
 
There is no description of any of these fields. No description of
FILE, FRONT-STR, REAR-STR, POS, or ANNOTATION. Also, the following
entry is missing, and is (increasingly) important for users of this
variable: (handler . HANDLER).
 
There is some explanation of these fields in the library commentary,
but I believe that it is incorrect as regards FRONT-STR and REAR-STR,
which are called STRING-IN-FRONT and STRING-BEHIND in the commentary:
 
;; STRING-IN-FRONT is a string of `bookmark-search-size' chars of
;;  context in front of the point at which the bookmark is set.
;; STRING-BEHIND is the same thing, but after the point.
 
I think this description is backwards.  The code shows that
STRING-IN-FRONT is in fact a string of text that immediatly *follows*
POS, and STRING-BEHIND is in fact a string that immediately *precedes*
POS.
 

In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
 

[Message part 3 (message/rfc822, inline)]

From: Karl Fogel <kfogel <at> red-bean.com>
To: 4195-close <at> debbugs.gnu.org
Subject: Fix "bookmark-alist and bookmark doc about structure"
Date: Sat, 24 Oct 2009 22:11:39 -0400

fixed
--

Thanks for the patch, Drew.  I committed it with very few tweaks:

  $ cvs ci -F ../msg bookmark.el ChangeLog
  /sources/emacs/emacs/lisp/bookmark.el,v  <--  bookmark.el
  new revision: 1.138; previous revision: 1.137
  /sources/emacs/emacs/lisp/ChangeLog,v  <--  ChangeLog
  new revision: 1.16507; previous revision: 1.16506
  Mailing notification to emacs-diffs <at> gnu.org... sent.
  $ 

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.