X-Git-Url: http://cgit.sxemacs.org/?a=blobdiff_plain;f=lisp%2Fproto-stream.el;h=fdf2abfea0579b700d95102d84293dd9738c0bb1;hb=d7925de009d5e3047e07e52657d7312d9f97979c;hp=9117ac9f4e37f6333a4cd29b5e6df78df2da1083;hpb=d79ddad8e47423c8c5acf5c7bfa95476cd89dfbe;p=gnus

diff --git a/lisp/proto-stream.el b/lisp/proto-stream.el
index 9117ac9f4..fdf2abfea 100644
--- a/lisp/proto-stream.el
+++ b/lisp/proto-stream.el
@@ -94,7 +94,15 @@ query server for capabilities.  For instance, for IMAP this is
 :starttls-function -- a function that takes one parameter, which
 is the response to the capaibility command.  It should return nil
 if it turns out that the server doesn't support STARTTLS, or the
-command to switch on STARTTLS otherwise."
+command to switch on STARTTLS otherwise.
+
+The return value from this function is a four-element list, where
+the first element is the stream (if connection was successful);
+the second element is the \"greeting\", i. e., the string the
+server sent over on initial contact; the third element is the
+capability string; and the fourth element is either `network' or
+`tls', depending on whether the connection ended up being
+encrypted or not."
   (let ((type (or (cadr (memq :type parameters)) 'network)))
     (cond
      ((eq type 'starttls)