From: Damien Cassou <damien@cassou.me>
Date: Sat, 4 Feb 2017 07:09:44 +0000 (+0100)
Subject: * lisp/auth-source.el: Document parser functions.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8e7448b13864b574f486dc905756cc6e2d48e25d;p=emacs.git

* lisp/auth-source.el: Document parser functions.
---

diff --git a/lisp/auth-source.el b/lisp/auth-source.el
index 5ad42772f94..3b60bd88d55 100644
--- a/lisp/auth-source.el
+++ b/lisp/auth-source.el
@@ -353,12 +353,15 @@ with \"[a/b/c] \" if CHOICES is \(?a ?b ?c)."
       k)))
 
 (defvar auth-source-backend-parser-functions nil
-  "List of auth-source parser functions
-These functions return backends from an entry in `auth-sources'.
-Add your backends to this list with `add-hook'.")
+  "List of auth-source parser functions.
+Each function takes an entry from `auth-sources' as parameter and
+returns a backend or nil if the entry is not supported.  Add a
+parser function to this list with `add-hook'.  Searching for a
+backend starts with the first element on the list and stops as
+soon as a function returns non-nil.")
 
 (defun auth-source-backend-parse (entry)
-  "Creates an auth-source-backend from an ENTRY in `auth-sources'."
+  "Create an auth-source-backend from an ENTRY in `auth-sources'."
 
   (let (backend)
     (dolist (f auth-source-backend-parser-functions)