Extend documentation of `nnmail-expiry-target' and the `expiry-target'

group parameter.  Add `expiry-target' to list of known group
parameters.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 0c434d8..b078970 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,9 @@
+2000-08-10  Kai Großjohann  <Kai.Grossjohann@CS.Uni-Dortmund.DE>
+
+       * nnmail.el (nnmail-expiry-target): More explicit documentation.
+
+       * gnus-cus.el (gnus-group-parameters): Add parameter `expiry-wait'.
+
 2000-08-09  Simon Josefsson <simon@josefsson.org>
 
        * imap.el (imap-parse-body):

diff --git a/lisp/gnus-cus.el b/lisp/gnus-cus.el
index 442ca05..7af9c93 100644 (file)
--- a/lisp/gnus-cus.el
+++ b/lisp/gnus-cus.el
@@ -181,6 +181,15 @@ when expiring expirable messages.  The value can either be a number of
 days (not necessarily an integer) or the symbols `never' or
 `immediate'.")
 
+    (expiry-target (choice :tag "Expiry Target"
+                           :value delete
+                           (const delete)
+                           (function :format "%v" nnmail-)
+                           string) "\
+Where expired messages end up.
+
+Overrides `nnmail-expiry-target', which see.")
+
     (score-file (file :tag "Score File") "\
 Make the specified file into the current score file.
 This means that all score commands you issue will end up in this file.")

diff --git a/lisp/nnmail.el b/lisp/nnmail.el
index 3976996..c01cd5c 100644 (file)
--- a/lisp/nnmail.el
+++ b/lisp/nnmail.el
@@ -168,7 +168,13 @@ Eg.:
                 (function :format "%v" nnmail-)))
 
 (defcustom nnmail-expiry-target 'delete
-  "*Variable that says where expired messages should end up."
+  "*Variable that says where expired messages should end up.
+The default value is `delete' (which says to delete the messages),
+but it can also be a string or a function.  If it is a string, expired
+messages end up in that group.  If it is a function, the function is
+called in a buffer narrowed to the message in question.  The function
+receives one argument, the name of the group the message comes from.
+The return value should be `delete' or a group name (a string)."
     :group 'nnmail-expire
     :type '(choice (const delete)
                   (function :format "%v" nnmail-)

diff --git a/texi/ChangeLog b/texi/ChangeLog
index b8dbed8..1d58fd0 100644 (file)
Binary files a/texi/ChangeLog and b/texi/ChangeLog differ

diff --git a/texi/gnus.texi b/texi/gnus.texi
index 0da0ee2..1984fc6 100644 (file)
--- a/texi/gnus.texi
+++ b/texi/gnus.texi
@@ -11908,14 +11908,22 @@ change the expiry period (@pxref{Group Parameters}).
 @vindex nnmail-expiry-target
 The normal action taken when expiring articles is to delete them.
 However, in some circumstances it might make more sense to move them to
-other groups instead of deleting them.  The @code{nnmail-expiry-target}
+other groups instead of deleting them.  The variable @code{nnmail-expiry-target}
 (and the @code{expiry-target} group parameter) controls this.  The
+variable supplies a default value for all groups, which can be
+overridden for specific groups by the group parameter.
 default value is @code{delete}, but this can also be a string (which
 should be the name of the group the message should be moved to), or a
 function (which will be called in a buffer narrowed to the message in
 question, and with the name of the group being moved from as its
 parameter) which should return a target -- either a group name or
-@code{delete}. 
+@code{delete}.
+
+Here's an example for specifying a group name:
+@lisp
+(setq nnmail-expiry-target "nnml:expired")
+@end lisp
+
 
 @vindex nnmail-keep-last-article
 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never