aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDamien Cassou2017-02-04 08:09:44 +0100
committerTed Zlatanov2017-04-27 17:37:58 -0400
commit9e43525077697e75244d1275ec0ba88a7c2ed7f9 (patch)
treee650f12a6c76b594726a6129e50bab2fc08694d2
parentbd60ee2ffc37b64a898d81184089b82afd55cae0 (diff)
downloademacs-9e43525077697e75244d1275ec0ba88a7c2ed7f9.tar.gz
emacs-9e43525077697e75244d1275ec0ba88a7c2ed7f9.zip
* lisp/auth-source.el: Document parser functions.
-rw-r--r--lisp/auth-source.el11
1 files changed, 7 insertions, 4 deletions
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)."
353 k))) 353 k)))
354 354
355(defvar auth-source-backend-parser-functions nil 355(defvar auth-source-backend-parser-functions nil
356 "List of auth-source parser functions 356 "List of auth-source parser functions.
357These functions return backends from an entry in `auth-sources'. 357Each function takes an entry from `auth-sources' as parameter and
358Add your backends to this list with `add-hook'.") 358returns a backend or nil if the entry is not supported. Add a
359parser function to this list with `add-hook'. Searching for a
360backend starts with the first element on the list and stops as
361soon as a function returns non-nil.")
359 362
360(defun auth-source-backend-parse (entry) 363(defun auth-source-backend-parse (entry)
361 "Creates an auth-source-backend from an ENTRY in `auth-sources'." 364 "Create an auth-source-backend from an ENTRY in `auth-sources'."
362 365
363 (let (backend) 366 (let (backend)
364 (dolist (f auth-source-backend-parser-functions) 367 (dolist (f auth-source-backend-parser-functions)