Doc changes for virtual server settings

Doc changes for virtual server settings

[Nevin Kapur]

I've been updating the docstrings for all the virtual server
parameters that I found in the Info node "Choosing a Mail Backend".

I have the following questions:

1. Where is nnfolder-delete-mail hook defined?

2. Is nnfolder-inhibit-expiry a virtual server parameter? The info
   file does not mention it.

3. Is nnml-inhibit-expiry a virtual server parameter? The info file
   does not mention it as one.


-- 
Nevin

Re: Doc changes for virtual server settings

[Lars Magne Ingebrigtsen]

Nevin Kapur <nevin@jhu.edu> writes:

> I have the following questions:
>
> 1. Where is nnfolder-delete-mail hook defined?

It's not defined anywhere, but I guess one could defvar it... 

> 2. Is nnfolder-inhibit-expiry a virtual server parameter? The info
>    file does not mention it.

I think it is.  Just look in the source code -- if it say `defvoo',
it's a server parameter.  If it's a variable, it says `defvar'.

-- 
(domestic pets only, the antidote for overdose, milk.)
   larsi@gnus.org * Lars Magne Ingebrigtsen

Re: Doc changes for virtual server settings

[Nevin Kapur]

Lars Magne Ingebrigtsen <larsi@gnus.org> writes:

> Nevin Kapur <nevin@jhu.edu> writes:
>
>> I have the following questions:
>>
>> 1. Where is nnfolder-delete-mail hook defined?
>
> It's not defined anywhere, but I guess one could defvar it... 

As per below, shouldn't one defvoo it?

>> 2. Is nnfolder-inhibit-expiry a virtual server parameter? The info
>>    file does not mention it.
>
> I think it is.  Just look in the source code -- if it say `defvoo',
> it's a server parameter.  If it's a variable, it says `defvar'.

OK. Here's the ChangeLog followed by the patch:

2001-08-17  Nevin Kapur  <nevin@jhu.edu>

	* nnmh.el: Docstring changes as below.

	* nnml.el: Docstring changes as below.

	* nnbabyl.el: Docstring changes as below.
	
	* nnmbox.el: Docstring changes as below.

	* nnfolder.el: Added docstrings identifying each virtual server
	parameter.

Index: lisp/nnbabyl.el
===================================================================
RCS file: /usr/local/cvsroot/gnus/lisp/nnbabyl.el,v
retrieving revision 6.3
diff -u -r6.3 nnbabyl.el
--- lisp/nnbabyl.el	2001/07/25 00:17:19	6.3
+++ lisp/nnbabyl.el	2001/08/17 21:47:57
@@ -43,16 +43,25 @@
 (nnoo-declare nnbabyl)
 
 (defvoo nnbabyl-mbox-file (expand-file-name "~/RMAIL")
-  "The name of the rmail box file in the users home directory.")
+  "The name of the rmail box file in the users home directory.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnbabyl-active-file (expand-file-name "~/.rmail-active")
-  "The name of the active file for the rmail box.")
+  "The name of the active file for the rmail box.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnbabyl-get-new-mail t
-  "If non-nil, nnbabyl will check the incoming mail file and split the mail.")
+  "If non-nil, nnbabyl will check the incoming mail file and split the mail.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
+
 (defvoo nnbabyl-prepare-save-mail-hook nil
-  "Hook run narrowed to an article before saving.")
+  "Hook run narrowed to an article before saving.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 \f
 
Index: lisp/nnfolder.el
===================================================================
RCS file: /usr/local/cvsroot/gnus/lisp/nnfolder.el,v
retrieving revision 6.13
diff -u -r6.13 nnfolder.el
--- lisp/nnfolder.el	2001/07/27 19:13:40	6.13
+++ lisp/nnfolder.el	2001/08/17 21:47:59
@@ -43,15 +43,19 @@
 (nnoo-declare nnfolder)
 
 (defvoo nnfolder-directory (expand-file-name message-directory)
-  "The name of the nnfolder directory.")
+  "The name of the nnfolder directory.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnfolder-nov-directory nil
   "The name of the nnfolder NOV directory.
 If nil, `nnfolder-directory' is used.")
 
 (defvoo nnfolder-active-file
     (nnheader-concat nnfolder-directory "active")
-  "The name of the active file.")
+  "The name of the active file.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 ;; I renamed this variable to something more in keeping with the general GNU
 ;; style. -SLB
@@ -73,20 +77,29 @@
 
 (defvoo nnfolder-newsgroups-file
     (concat (file-name-as-directory nnfolder-directory) "newsgroups")
-  "Mail newsgroups description file.")
+  "Mail newsgroups description file.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnfolder-get-new-mail t
-  "If non-nil, nnfolder will check the incoming mail file and split the mail.")
+  "If non-nil, nnfolder will check the incoming mail file and split the mail.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnfolder-prepare-save-mail-hook nil
   "Hook run narrowed to an article before saving.")
 
 (defvoo nnfolder-save-buffer-hook nil
-  "Hook run before saving the nnfolder mbox buffer.")
+  "Hook run before saving the nnfolder mbox buffer.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
+
 (defvoo nnfolder-inhibit-expiry nil
-  "If non-nil, inhibit expiry.")
+  "If non-nil, inhibit expiry.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 \f
 
 (defconst nnfolder-version "nnfolder 2.0"
@@ -117,7 +130,9 @@
 set this to t, and want to set it to nil again, you should always run
 the `nnfolder-generate-active-file' command.  The function will go
 through all nnfolder directories and generate nov databases for them
-all.  This may very well take some time.")
+all.  This may very well take some time.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnfolder-nov-file-suffix ".nov")
 
Index: lisp/nnmbox.el
===================================================================
RCS file: /usr/local/cvsroot/gnus/lisp/nnmbox.el,v
retrieving revision 6.6
diff -u -r6.6 nnmbox.el
--- lisp/nnmbox.el	2001/08/11 06:12:28	6.6
+++ lisp/nnmbox.el	2001/08/17 21:48:00
@@ -36,16 +36,24 @@
 (nnoo-declare nnmbox)
 
 (defvoo nnmbox-mbox-file (expand-file-name "~/mbox")
-  "The name of the mail box file in the user's home directory.")
+  "The name of the mail box file in the user's home directory.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnmbox-active-file (expand-file-name "~/.mbox-active")
-  "The name of the active file for the mail box.")
+  "The name of the active file for the mail box.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnmbox-get-new-mail t
-  "If non-nil, nnmbox will check the incoming mail file and split the mail.")
+  "If non-nil, nnmbox will check the incoming mail file and split the mail.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnmbox-prepare-save-mail-hook nil
-  "Hook run narrowed to an article before saving.")
+  "Hook run narrowed to an article before saving.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 \f
 
Index: lisp/nnmh.el
===================================================================
RCS file: /usr/local/cvsroot/gnus/lisp/nnmh.el,v
retrieving revision 6.4
diff -u -r6.4 nnmh.el
--- lisp/nnmh.el	2001/07/25 00:17:23	6.4
+++ lisp/nnmh.el	2001/08/17 21:48:01
@@ -41,19 +41,27 @@
 (nnoo-declare nnmh)
 
 (defvoo nnmh-directory message-directory
-  "*Mail spool directory.")
+  "*Mail spool directory.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnmh-get-new-mail t
-  "*If non-nil, nnmh will check the incoming mail file and split the mail.")
+  "*If non-nil, nnmh will check the incoming mail file and split the mail.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnmh-prepare-save-mail-hook nil
-  "*Hook run narrowed to an article before saving.")
+  "*Hook run narrowed to an article before saving.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnmh-be-safe nil
   "*If non-nil, nnmh will check all articles to make sure whether they are new or not.
 Go through the .nnmh-articles file and compare with the actual
 articles in this folder.  The articles that are \"new\" will be marked
-as unread by Gnus.")
+as unread by Gnus.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 \f
 
Index: lisp/nnml.el
===================================================================
RCS file: /usr/local/cvsroot/gnus/lisp/nnml.el,v
retrieving revision 6.8
diff -u -r6.8 nnml.el
--- lisp/nnml.el	2001/07/25 00:17:23	6.8
+++ lisp/nnml.el	2001/08/17 21:48:02
@@ -39,18 +39,26 @@
 (nnoo-declare nnml)
 
 (defvoo nnml-directory message-directory
-  "Spool directory for the nnml mail backend.")
+  "Spool directory for the nnml mail backend.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnml-active-file
     (expand-file-name "active" nnml-directory)
-  "Mail active file.")
+  "Mail active file.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnml-newsgroups-file
     (expand-file-name "newsgroups" nnml-directory)
-  "Mail newsgroups description file.")
+  "Mail newsgroups description file.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnml-get-new-mail t
-  "If non-nil, nnml will check the incoming mail file and split the mail.")
+  "If non-nil, nnml will check the incoming mail file and split the mail.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnml-nov-is-evil nil
   "If non-nil, Gnus will never generate and use nov databases for mail groups.
@@ -59,13 +67,19 @@
 set this to t, and want to set it to nil again, you should always run
 the `nnml-generate-nov-databases' command.  The function will go
 through all nnml directories and generate nov databases for them
-all.  This may very well take some time.")
+all.  This may very well take some time.
 
+This variable is a virtual server slot.  See the Gnus manual for details.")
+
 (defvoo nnml-prepare-save-mail-hook nil
-  "Hook run narrowed to an article before saving.")
+  "Hook run narrowed to an article before saving.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 (defvoo nnml-inhibit-expiry nil
-  "If non-nil, inhibit expiry.")
+  "If non-nil, inhibit expiry.
+
+This variable is a virtual server slot.  See the Gnus manual for details.")
 
 
 \f
cvs server: Diffing texi
cvs server: Diffing texi/ps

-- 
Nevin

Re: Doc changes for virtual server settings

[Lars Magne Ingebrigtsen]

Nevin Kapur <nevin@jhu.edu> writes:

> As per below, shouldn't one defvoo it?

Yup.

> OK. Here's the ChangeLog followed by the patch:

Thanks for the patch; I've applied it to Oort Gnus v0.04.

-- 
(domestic pets only, the antidote for overdose, milk.)
   larsi@gnus.org * Lars Magne Ingebrigtsen