(gnus-activate-group): Document more parameters (bug#9694).
authorLars Magne Ingebrigtsen <larsi@stories.(none)>
Fri, 6 Jan 2012 23:10:44 +0000 (00:10 +0100)
committerLars Magne Ingebrigtsen <larsi@stories.(none)>
Fri, 6 Jan 2012 23:10:44 +0000 (00:10 +0100)
lisp/ChangeLog
lisp/gnus-int.el
lisp/gnus-start.el

index 4db6a39..90bc5bb 100644 (file)
@@ -1,5 +1,8 @@
 2012-01-06  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
+       * gnus-start.el (gnus-activate-group): Document more parameters
+       (bug#9694).
+
        * gnus-group.el (gnus-group-read-ephemeral-group): Doc clarification
        (bug#9692).
 
index 95c8a44..20add47 100644 (file)
@@ -396,7 +396,7 @@ If it is down, start it up (again)."
     result))
 
 (defun gnus-request-compact (gnus-command-method)
-  "Request groups compaction  from GNUS-COMMAND-METHOD."
+  "Request groups compaction from GNUS-COMMAND-METHOD."
   (when (stringp gnus-command-method)
     (setq gnus-command-method (gnus-server-to-method gnus-command-method)))
   (funcall (gnus-get-function gnus-command-method 'request-compact)
index 73ec7b6..782773d 100644 (file)
@@ -1451,7 +1451,11 @@ newsgroup."
 (defun gnus-activate-group (group &optional scan dont-check method
                                  dont-sub-check)
   "Check whether a group has been activated or not.
-If SCAN, request a scan of that group as well."
+If SCAN, request a scan of that group as well.  If METHOD, use
+that select method instead of determining the method based on the
+group name.  If DONT-CHECK, don't check check whether the group
+actually exists.  If DONT-SUB-CHECK or DONT-CHECK, don't let the
+backend check whether the group actually exists."
   (let ((method (or method (inline (gnus-find-method-for-group group))))
        active)
     (and (inline (gnus-check-server method))