From a145ef44f6e5c98992c30bdeb71cb28684e4e840 Mon Sep 17 00:00:00 2001 From: Simon Josefsson Date: Wed, 12 Dec 2001 20:32:41 +0000 Subject: [PATCH] 2001-12-12 Simon Josefsson * nnvirtual.el (nnvirtual-always-rescan) (nnvirtual-component-regexp): Fix doc. * nnoo.el (defvoo): Add doc to defvoo variables. * nnml.el (nnml-directory, nnml-active-file) (nnml-newsgroups-file, nnml-get-new-mail, nnml-nov-is-evil) (nnml-marks-is-evil, nnml-filenames-are-evil) (nnml-prepare-save-mail-hook, nnml-inhibit-expiry): Fix doc. * nnmh.el (nnmh-directory, nnmh-get-new-mail) (nnmh-prepare-save-mail-hook, nnmh-be-safe): Fix doc. (nnmh-possibly-change-directory): Use `nnheader-report' instead of `error'. * nnmbox.el (nnmbox-mbox-file, nnmbox-active-file) (nnmbox-get-new-mail, nnmbox-prepare-save-mail-hook): * nnfolder.el (nnfolder-directory, nnfolder-active-file) (nnfolder-newsgroups-file, nnfolder-get-new-mail) (nnfolder-save-buffer-hook, nnfolder-inhibit-expiry) (nnfolder-nov-is-evil, nnfolder-marks-is-evil): Fix doc. * nnbabyl.el (nnbabyl-mbox-file, nnbabyl-active-file) (nnbabyl-get-new-mail, nnbabyl-prepare-save-mail-hook): Fix doc. * imap.el, nnimap.el: Fix indentation. * gnus-sieve.el (gnus-sieve-article-add-rule): Autoload it. --- lisp/ChangeLog | 32 ++++++++++++++++++++++++++++++++ lisp/gnus-sieve.el | 1 + lisp/imap.el | 8 ++++---- lisp/nnbabyl.el | 16 ++++------------ lisp/nnfolder.el | 32 ++++++++------------------------ lisp/nnimap.el | 2 +- lisp/nnmbox.el | 16 ++++------------ lisp/nnmh.el | 20 ++++++-------------- lisp/nnml.el | 36 +++++++++--------------------------- lisp/nnoo.el | 2 +- lisp/nnvirtual.el | 4 ++-- 11 files changed, 72 insertions(+), 97 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 3d368ee55..fa537f95e 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,35 @@ +2001-12-12 Simon Josefsson + + * nnvirtual.el (nnvirtual-always-rescan) + (nnvirtual-component-regexp): Fix doc. + + * nnoo.el (defvoo): Add doc to defvoo variables. + + * nnml.el (nnml-directory, nnml-active-file) + (nnml-newsgroups-file, nnml-get-new-mail, nnml-nov-is-evil) + (nnml-marks-is-evil, nnml-filenames-are-evil) + (nnml-prepare-save-mail-hook, nnml-inhibit-expiry): Fix doc. + + * nnmh.el (nnmh-directory, nnmh-get-new-mail) + (nnmh-prepare-save-mail-hook, nnmh-be-safe): Fix doc. + (nnmh-possibly-change-directory): Use `nnheader-report' instead of + `error'. + + * nnmbox.el (nnmbox-mbox-file, nnmbox-active-file) + (nnmbox-get-new-mail, nnmbox-prepare-save-mail-hook): + + * nnfolder.el (nnfolder-directory, nnfolder-active-file) + (nnfolder-newsgroups-file, nnfolder-get-new-mail) + (nnfolder-save-buffer-hook, nnfolder-inhibit-expiry) + (nnfolder-nov-is-evil, nnfolder-marks-is-evil): Fix doc. + + * nnbabyl.el (nnbabyl-mbox-file, nnbabyl-active-file) + (nnbabyl-get-new-mail, nnbabyl-prepare-save-mail-hook): Fix doc. + + * imap.el, nnimap.el: Fix indentation. + + * gnus-sieve.el (gnus-sieve-article-add-rule): Autoload it. + 2001-12-12 Didier Verna * gnus-msg.el (gnus-group-news): New function. diff --git a/lisp/gnus-sieve.el b/lisp/gnus-sieve.el index 209912ca7..2553358f8 100644 --- a/lisp/gnus-sieve.el +++ b/lisp/gnus-sieve.el @@ -120,6 +120,7 @@ Return NIL if no rule could be guessed." (when (message-fetch-field "sender") `(sieve address "sender" ,(regexp-quote (message-fetch-field "sender"))))) +;;;###autoload (defun gnus-sieve-article-add-rule () (interactive) (gnus-summary-select-article nil 'force) diff --git a/lisp/imap.el b/lisp/imap.el index 923880d8c..a728a65c4 100644 --- a/lisp/imap.el +++ b/lisp/imap.el @@ -497,11 +497,11 @@ If ARGS, PROMPT is used as an argument to `format'." (while (and (memq (process-status process) '(open run)) (set-buffer buffer) ;; XXX "blue moon" nntp.el bug (goto-char (point-min)) - ;; cyrus 1.6.x (13? < x <= 22) queries capabilities + ;; cyrus 1.6.x (13? < x <= 22) queries capabilities (or (while (looking-at "^C:") (forward-line)) t) - ;; cyrus 1.6 imtest print "S: " before server greeting + ;; cyrus 1.6 imtest print "S: " before server greeting (or (not (looking-at "S: ")) (forward-char 3) t) @@ -561,11 +561,11 @@ If ARGS, PROMPT is used as an argument to `format'." (while (and (memq (process-status process) '(open run)) (set-buffer buffer) ;; XXX "blue moon" nntp.el bug (goto-char (point-min)) - ;; cyrus 1.6.x (13? < x <= 22) queries capabilities + ;; cyrus 1.6.x (13? < x <= 22) queries capabilities (or (while (looking-at "^C:") (forward-line)) t) - ;; cyrus 1.6 imtest print "S: " before server greeting + ;; cyrus 1.6 imtest print "S: " before server greeting (or (not (looking-at "S: ")) (forward-char 3) t) diff --git a/lisp/nnbabyl.el b/lisp/nnbabyl.el index 08fd8f359..b9acfe641 100644 --- a/lisp/nnbabyl.el +++ b/lisp/nnbabyl.el @@ -43,25 +43,17 @@ (nnoo-declare nnbabyl) (defvoo nnbabyl-mbox-file (expand-file-name "~/RMAIL") - "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.") + "The name of the rmail box file in the users home directory.") (defvoo nnbabyl-active-file (expand-file-name "~/.rmail-active") - "The name of the active file for the rmail box. - -This variable is a virtual server slot. See the Gnus manual for details.") + "The name of the active file for the rmail box.") (defvoo nnbabyl-get-new-mail t - "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.") + "If non-nil, nnbabyl will check the incoming mail file and split the mail.") (defvoo nnbabyl-prepare-save-mail-hook nil - "Hook run narrowed to an article before saving. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Hook run narrowed to an article before saving.") diff --git a/lisp/nnfolder.el b/lisp/nnfolder.el index e6781409c..da17dee15 100644 --- a/lisp/nnfolder.el +++ b/lisp/nnfolder.el @@ -46,9 +46,7 @@ (nnoo-declare nnfolder) (defvoo nnfolder-directory (expand-file-name message-directory) - "The name of the nnfolder directory. - -This variable is a virtual server slot. See the Gnus manual for details.") + "The name of the nnfolder directory.") (defvoo nnfolder-nov-directory nil "The name of the nnfolder NOV directory. @@ -60,9 +58,7 @@ If nil, `nnfolder-directory' is used.") (defvoo nnfolder-active-file (nnheader-concat nnfolder-directory "active") - "The name of the active file. - -This variable is a virtual server slot. See the Gnus manual for details.") + "The name of the active file.") ;; I renamed this variable to something more in keeping with the general GNU ;; style. -SLB @@ -84,28 +80,20 @@ message, a huge time saver for large mailboxes.") (defvoo nnfolder-newsgroups-file (concat (file-name-as-directory nnfolder-directory) "newsgroups") - "Mail newsgroups description file. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Mail newsgroups description file.") (defvoo nnfolder-get-new-mail t - "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.") + "If non-nil, nnfolder will check the incoming mail file and split the mail.") (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. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Hook run before saving the nnfolder mbox buffer.") (defvoo nnfolder-inhibit-expiry nil - "If non-nil, inhibit expiry. - -This variable is a virtual server slot. See the Gnus manual for details.") + "If non-nil, inhibit expiry.") @@ -137,9 +125,7 @@ This variable shouldn't be flipped much. If you have, for some reason, 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. - -This variable is a virtual server slot. See the Gnus manual for details.") +all. This may very well take some time.") (defvoo nnfolder-nov-file-suffix ".nov") @@ -154,9 +140,7 @@ separately from `.newsrc.eld'. If you have, for some reason, set this to t, and want to set it to nil again, you should always remove the corresponding marks file (usually base nnfolder file name concatenated with `.mrk', but see `nnfolder-marks-file-suffix') for -the group. Then the marks file will be regenerated properly by Gnus. - -This variable is a virtual server slot. See the Gnus manual for details.") +the group. Then the marks file will be regenerated properly by Gnus.") (defvoo nnfolder-marks nil) diff --git a/lisp/nnimap.el b/lisp/nnimap.el index b10077396..c82011f3e 100644 --- a/lisp/nnimap.el +++ b/lisp/nnimap.el @@ -488,7 +488,7 @@ If EXAMINE is non-nil the group is selected read-only." mbx imap-current-mailbox headers (nnimap-demule (if (imap-capability 'IMAP4rev1) - ;; xxx don't just use car? alist doesn't contain + ;; xxx don't just use car? alist doesn't contain ;; anything else now, but it might... (nth 2 (car (imap-message-get uid 'BODYDETAIL))) (imap-message-get uid 'RFC822.HEADER))) diff --git a/lisp/nnmbox.el b/lisp/nnmbox.el index bf62dfb62..72e144f3b 100644 --- a/lisp/nnmbox.el +++ b/lisp/nnmbox.el @@ -36,24 +36,16 @@ (nnoo-declare nnmbox) (defvoo nnmbox-mbox-file (expand-file-name "~/mbox") - "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.") + "The name of the mail box file in the user's home directory.") (defvoo nnmbox-active-file (expand-file-name "~/.mbox-active") - "The name of the active file for the mail box. - -This variable is a virtual server slot. See the Gnus manual for details.") + "The name of the active file for the mail box.") (defvoo nnmbox-get-new-mail t - "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.") + "If non-nil, nnmbox will check the incoming mail file and split the mail.") (defvoo nnmbox-prepare-save-mail-hook nil - "Hook run narrowed to an article before saving. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Hook run narrowed to an article before saving.") diff --git a/lisp/nnmh.el b/lisp/nnmh.el index 7d562d409..d3f164ab2 100644 --- a/lisp/nnmh.el +++ b/lisp/nnmh.el @@ -41,27 +41,19 @@ (nnoo-declare nnmh) (defvoo nnmh-directory message-directory - "*Mail spool directory. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Mail spool directory.") (defvoo nnmh-get-new-mail t - "*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.") + "If non-nil, nnmh will check the incoming mail file and split the mail.") (defvoo nnmh-prepare-save-mail-hook nil - "*Hook run narrowed to an article before saving. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Hook run narrowed to an article before saving.") (defvoo nnmh-be-safe nil - "*If non-nil, nnmh will check all articles to make sure whether they are new or not. + "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. - -This variable is a virtual server slot. See the Gnus manual for details.") +as unread by Gnus.") @@ -432,7 +424,7 @@ This variable is a virtual server slot. See the Gnus manual for details.") (file-name-coding-system nnmail-pathname-coding-system)) (if (file-directory-p pathname) (setq nnmh-current-directory pathname) - (error "No such newsgroup: %s" newsgroup))))) + (nnheader-report 'nnmh "Not a directory: %s" nnmh-directory))))) (defun nnmh-possibly-create-directory (group) (let (dir dirs) diff --git a/lisp/nnml.el b/lisp/nnml.el index b2fc3730b..b7eb5b1fb 100644 --- a/lisp/nnml.el +++ b/lisp/nnml.el @@ -44,26 +44,18 @@ (nnoo-declare nnml) (defvoo nnml-directory message-directory - "Spool directory for the nnml mail backend. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Spool directory for the nnml mail backend.") (defvoo nnml-active-file (expand-file-name "active" nnml-directory) - "Mail active file. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Mail active file.") (defvoo nnml-newsgroups-file (expand-file-name "newsgroups" nnml-directory) - "Mail newsgroups description file. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Mail newsgroups description file.") (defvoo nnml-get-new-mail t - "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.") + "If non-nil, nnml will check the incoming mail file and split the mail.") (defvoo nnml-nov-is-evil nil "If non-nil, Gnus will never generate and use nov databases for mail spools. @@ -72,9 +64,7 @@ This variable shouldn't be flipped much. If you have, for some reason, 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. - -This variable is a virtual server slot. See the Gnus manual for details.") +all. This may very well take some time.") (defvoo nnml-marks-is-evil nil "If non-nil, Gnus will never generate and use marks file for mail spools. @@ -83,26 +73,18 @@ separately from `.newsrc.eld'. If you have, for some reason, set this to t, and want to set it to nil again, you should always remove the corresponding marks file (usually named `.marks' in the nnml group directory, but see `nnml-marks-file-name') for the group. Then the -marks file will be regenerated properly by Gnus. - -This variable is a virtual server slot. See the Gnus manual for details.") +marks file will be regenerated properly by Gnus.") (defvoo nnml-filenames-are-evil t "If non-nil, Gnus will not assume that the articles file name is the same as the article number listed in the nov database. This -variable should be set if any of the files are compressed. - -This variable is a virtual server slot. See the Gnus manual for details.") +variable should be set if any of the files are compressed.") (defvoo nnml-prepare-save-mail-hook nil - "Hook run narrowed to an article before saving. - -This variable is a virtual server slot. See the Gnus manual for details.") + "Hook run narrowed to an article before saving.") (defvoo nnml-inhibit-expiry nil - "If non-nil, inhibit expiry. - -This variable is a virtual server slot. See the Gnus manual for details.") + "If non-nil, inhibit expiry.") diff --git a/lisp/nnoo.el b/lisp/nnoo.el index 945ca567c..8a360d9e1 100644 --- a/lisp/nnoo.el +++ b/lisp/nnoo.el @@ -38,7 +38,7 @@ "The same as `defvar', only takes list of variables to MAP to." `(prog1 ,(if doc - `(defvar ,var ,init ,doc) + `(defvar ,var ,init ,(concat doc "\n\nThis is a Gnus server variable. See Info node `(gnus)Select Methods'.")) `(defvar ,var ,init)) (nnoo-define ',var ',map))) (put 'defvoo 'lisp-indent-function 2) diff --git a/lisp/nnvirtual.el b/lisp/nnvirtual.el index b859ce5b3..bd45c7d5b 100644 --- a/lisp/nnvirtual.el +++ b/lisp/nnvirtual.el @@ -45,13 +45,13 @@ (nnoo-declare nnvirtual) (defvoo nnvirtual-always-rescan t - "*If non-nil, always scan groups for unread articles when entering a group. + "If non-nil, always scan groups for unread articles when entering a group. If this variable is nil and you read articles in a component group after the virtual group has been activated, the read articles from the component group will show up when you enter the virtual group.") (defvoo nnvirtual-component-regexp nil - "*Regexp to match component groups.") + "Regexp to match component groups.") (defvoo nnvirtual-component-groups nil "Component group in this nnvirtual group.") -- 2.25.1