[Emacs-diffs] master a1cb68b 5/6: Document nnimap-shell-program

[Lars Ingebrigtsen]

branch: master
commit a1cb68be6c94513c436fd52e4453cb7afe28f2ba
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    Document nnimap-shell-program
    
    * lisp/gnus/nnimap.el (nnimap-shell-program): Document
    nnimap-shell-program (bug#20651).
---
 lisp/gnus/nnimap.el |    6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/lisp/gnus/nnimap.el b/lisp/gnus/nnimap.el
index 700e86a..5d38924 100644
--- a/lisp/gnus/nnimap.el
+++ b/lisp/gnus/nnimap.el
@@ -67,7 +67,11 @@ back on `network'.")
                                 (if (listp imap-shell-program)
                                     (car imap-shell-program)
                                   imap-shell-program)
-                              "ssh %s imapd"))
+                              "ssh %s imapd")
+  "What command to execute to connect to an IMAP server.
+This will only be used if the connection type is `shell'.  See
+the `make-network-process' documentation for an explanation of
+the format.)
 
 (defvoo nnimap-inbox nil
   "The mail box where incoming mail arrives and should be split out of.