]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/auth-source.el: Document parser functions.
authorDamien Cassou <damien@cassou.me>
Sat, 4 Feb 2017 07:09:44 +0000 (08:09 +0100)
committerTed Zlatanov <tzz@lifelogs.com>
Wed, 26 Apr 2017 19:07:52 +0000 (15:07 -0400)
lisp/auth-source.el

index 5ad42772f94dca53470b25495d057e9174ba6bf3..3b60bd88d55a965d91a681ff221510a92f9b9887 100644 (file)
@@ -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)