summaryrefslogtreecommitdiff
path: root/lisp/gnus/proto-stream.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2011-02-06 22:27:28 +0000
committerKatsumi Yamaoka <yamaoka@jpl.org>2011-02-06 22:27:28 +0000
commit76b8d9dd0ed6811c0fc1bbde5d9e3b0cf6c61cf1 (patch)
treeaa7146a9e12a219b55b296833497e8ff6854babc /lisp/gnus/proto-stream.el
parente765a388299ce398f7f5cf57bc74b8134d785f43 (diff)
downloademacs-76b8d9dd0ed6811c0fc1bbde5d9e3b0cf6c61cf1.tar.gz
nntp.el (nntp-finish-retrieve-group-infos): Protect against the first part not returning any data.
proto-stream.el (open-protocol-stream): Document the return value.
Diffstat (limited to 'lisp/gnus/proto-stream.el')
-rw-r--r--lisp/gnus/proto-stream.el10
1 files changed, 9 insertions, 1 deletions
diff --git a/lisp/gnus/proto-stream.el b/lisp/gnus/proto-stream.el
index 9117ac9f4e3..fdf2abfea05 100644
--- a/lisp/gnus/proto-stream.el
+++ b/lisp/gnus/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)