[Emacs-diffs] /srv/bzr/emacs/trunk r103909: gnus.texi (nnmairix caveats, Setup, Registry Article Refer Method)

[Katsumi Yamaoka]

------------------------------------------------------------
revno: 103909
author: Teodor Zlatanov <address@hidden>
committer: Katsumi Yamaoka <address@hidden>
branch nick: trunk
timestamp: Thu 2011-04-14 10:41:00 +0000
message:
  gnus.texi (nnmairix caveats, Setup, Registry Article Refer Method)
   (Fancy splitting to parent, Store arbitrary data): Updated gnus-registry 
docs.
  gnus-registry.el: Updated gnus-registry docs.
modified:
  doc/misc/ChangeLog
  doc/misc/gnus.texi
  lisp/gnus/ChangeLog
  lisp/gnus/gnus-registry.el

=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog        2011-04-13 11:58:47 +0000
+++ b/doc/misc/ChangeLog        2011-04-14 10:41:00 +0000
@@ -1,3 +1,9 @@
+2011-04-14  Teodor Zlatanov  <address@hidden>
+
+       * gnus.texi (nnmairix caveats, Setup, Registry Article Refer Method)
+       (Fancy splitting to parent, Store arbitrary data): Updated
+       gnus-registry docs.
+
 2011-04-13  Juanma Barranquero  <address@hidden>
 
        * ede.texi: Fix typos.

=== modified file 'doc/misc/gnus.texi'
--- a/doc/misc/gnus.texi        2011-04-12 22:18:02 +0000
+++ b/doc/misc/gnus.texi        2011-04-14 10:41:00 +0000
@@ -22061,10 +22061,11 @@
 @item
 If you use the Gnus registry: don't use the registry with
 @code{nnmairix} groups (put them in
address@hidden).  Be @emph{extra careful} if
-you use @code{gnus-registry-split-fancy-with-parent}; mails which are
-split into @code{nnmairix} groups are usually gone for good as soon as
-you check the group for new mail (yes, it has happened to me...).
address@hidden; this is the default).  Be
address@hidden careful} if you use
address@hidden; mails which are split
+into @code{nnmairix} groups are usually gone for good as soon as you
+check the group for new mail (yes, it has happened to me...).
 
 @item
 Therefore: @emph{Never ever} put ``real'' mails into @code{nnmairix}
@@ -25916,8 +25917,7 @@
 Fortunately, setting up the Gnus registry is pretty easy:
 
 @lisp
-(setq gnus-registry-max-entries 2500
-      gnus-registry-use-long-group-names t)
+(setq gnus-registry-max-entries 2500)
 
 (gnus-registry-initialize)
 @end lisp
@@ -25939,16 +25939,16 @@
                                 ("spam" t)
                                 ("train" t))
  gnus-registry-max-entries 500000
- gnus-registry-use-long-group-names t
+ ;; this is the default
  gnus-registry-track-extra '(sender subject))
 @end lisp
 
-They say: keep a lot of messages around, use long group names, track
-messages by sender and subject (not just parent Message-ID), and when
-the registry splits incoming mail, use a majority rule to decide where
-messages should go if there's more than one possibility.  In addition,
-the registry should ignore messages in groups that match ``nntp'',
-``nnrss'', ``spam'', or ``train.''
+They say: keep a lot of messages around, track messages by sender and
+subject (not just parent Message-ID), and when the registry splits
+incoming mail, use a majority rule to decide where messages should go
+if there's more than one possibility.  In addition, the registry
+should ignore messages in groups that match ``nntp'', ``nnrss'',
+``spam'', or ``train.''
 
 You are doubtless impressed by all this, but you ask: ``I am a Gnus
 user, I customize to live.  Give me more.''  Here you go, these are
@@ -25958,19 +25958,9 @@
 The groups that will not be followed by
 @code{gnus-registry-split-fancy-with-parent}.  They will still be
 remembered by the registry.  This is a list of regular expressions.
address@hidden defvar
-
address@hidden gnus-registry-ignored-groups
-The groups that will not be remembered by the registry.  This is a
-list of regular expressions, also available through Group/Topic
-customization (so you can ignore or keep a specific group or a whole
-topic).
address@hidden defvar
-
address@hidden gnus-registry-use-long-group-names
-Whether the registry will use long group names.  It's recommended to
-set this to @code{t}, although everything works if you don't.  Future
-functionality will require it.
+By default any group name that ends with ``delayed,'' ``drafts,''
+``queue,'' or ``INBOX'', belongs to the nnmairix backend, or contains
+the word ``archive'' is not followed.
 @end defvar
 
 @defvar gnus-registry-max-entries
@@ -25978,8 +25968,15 @@
 registry will keep.
 @end defvar
 
address@hidden gnus-registry-max-pruned-entries
+The maximum number (an integer or @code{nil} for unlimited) of entries
+the registry will keep after pruning.
address@hidden defvar
+
 @defvar gnus-registry-cache-file
-The file where the registry will be stored between Gnus sessions.
+The file where the registry will be stored between Gnus sessions.  By
+default the file name is @code{.gnus.registry.eioio} in the same
+directory as your @code{.newsrc.eld}.
 @end defvar
 
 @node Registry Article Refer Method
@@ -26003,8 +26000,7 @@
 ;; Keep enough entries to have a good hit rate when referring to an
 ;; article using the registry.  Use long group names so that Gnus
 ;; knows where the article is.
-(setq gnus-registry-max-entries 2500
-      gnus-registry-use-long-group-names t)
+(setq gnus-registry-max-entries 2500)
 
 (gnus-registry-initialize)
 
@@ -26050,9 +26046,8 @@
 
 @defvar gnus-registry-track-extra
 This is a list of symbols, so it's best to change it from the
-Customize interface.  By default it's @code{nil}, but you may want to
-track @code{subject} and @code{sender} as well when splitting by parent.
-It may work for you.  It can be annoying if your mail flow is large and
+Customize interface.  By default it's @code{(subject sender)}, which
+may work for you.  It can be annoying if your mail flow is large and
 people don't stick to the same groups.
 @end defvar
 
@@ -26060,7 +26055,8 @@
 This is a symbol, so it's best to change it from the Customize
 interface.  By default it's @code{nil}, but you may want to set it to
 @code{majority} or @code{first} to split by sender or subject based on
-the majority of matches or on the first found.
+the majority of matches or on the first found.  I find @code{majority}
+works best.
 @end defvar
 
 @node Store custom flags and keywords
@@ -26095,17 +26091,12 @@
 store arbitrary data (as long as it can be converted to a list for
 storage).
 
address@hidden gnus-registry-store-extra-entry (id key value)
-Store @code{value} in the extra data key @code{key} for message
address@hidden
address@hidden defun
-
address@hidden gnus-registry-delete-extra-entry (id key)
-Delete the extra data key @code{key} for message @code{id}.
address@hidden defun
-
address@hidden gnus-registry-fetch-extra (id key)
-Get the extra data key @code{key} for message @code{id}.
address@hidden gnus-registry-set-id-key (id key value)
+Store @code{value} under @code{key} for message @code{id}.
address@hidden defun
+
address@hidden gnus-registry-get-id-key (id key)
+Get the data under @code{key} for message @code{id}.
 @end defun
 
 @defvar gnus-registry-extra-entries-precious

=== modified file 'lisp/gnus/ChangeLog'
--- a/lisp/gnus/ChangeLog       2011-04-12 22:18:02 +0000
+++ b/lisp/gnus/ChangeLog       2011-04-14 10:41:00 +0000
@@ -1,3 +1,7 @@
+2011-04-14  Teodor Zlatanov  <address@hidden>
+
+       * gnus-registry.el: Updated gnus-registry docs.
+
 2011-04-12  Teodor Zlatanov  <address@hidden>
 
        * gnus-registry.el (gnus-registry--split-fancy-with-parent-internal):

=== modified file 'lisp/gnus/gnus-registry.el'
--- a/lisp/gnus/gnus-registry.el        2011-04-12 22:18:02 +0000
+++ b/lisp/gnus/gnus-registry.el        2011-04-14 10:41:00 +0000
@@ -33,9 +33,10 @@
 ;; you, submit a bug report and I'll be glad to fix it.  It needs
 ;; documentation in the manual (also on my to-do list).
 
-;; Put this in your startup file (~/.gnus.el for instance)
+;; Put this in your startup file (~/.gnus.el for instance) or use Customize:
 
-;; (setq gnus-registry-max-entries 2500)
+;; (setq gnus-registry-max-entries 2500
+;;       gnus-registry-track-extra '(sender subject))
 
 ;; (gnus-registry-initialize)