aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorTeodor Zlatanov <[email protected]>2011-03-13 04:07:38 +0000
committerKatsumi Yamaoka <[email protected]>2011-03-13 04:07:38 +0000
commit4248cca2de96a6732a233e9c1d13c6336b215705 (patch)
tree808e2d99401ed0d77cbe21a9815a35b62988946f /doc/misc
parent8d9101d850b5ad006ce41a231f294ea6de93986a (diff)
Merge changes made in Gnus trunk.
auth.texi (Help for developers): Update docs to explain that the :save-function will only run the first time. auth-source.el (auth-source-format-prompt): Always convert the value to a string to avoid evaluating non-string arguments. (auth-source-netrc-create): Offer default properly, not as initial content in `read-string'. (auth-source-netrc-saver): Use a cache keyed by file name and MD5 hash of line to determine if we've been run before. If so, don't run again, but print a trivial message to indicate the cache was hit instead.
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/ChangeLog5
-rw-r--r--doc/misc/auth.texi12
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 1a1ca1d629..db3a944c16 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,8 @@
+2011-03-12 Teodor Zlatanov <[email protected]>
+
+ * auth.texi (Help for developers): Update docs to explain that the
+ :save-function will only run the first time.
+
2011-03-12 Glenn Morris <[email protected]>
* Makefile.in (emacs-faq.html): Fix some more cross-refs.
diff --git a/doc/misc/auth.texi b/doc/misc/auth.texi
index 85a3f09813..a16da92343 100644
--- a/doc/misc/auth.texi
+++ b/doc/misc/auth.texi
@@ -289,11 +289,21 @@ Later, after a successful login, @code{nnimal.el} calls the
(funcall (nth 2 credentials)))
@end example
-Which will work whether the @code{:save-function} was provided or not.
+This will work whether the @code{:save-function} was provided or not.
@code{:save-function} will be provided only when a new entry was
created, so this effectively says ``after a successful login, save the
authentication information we just used, if it was newly created.''
+After the first time it's called, the @code{:save-function} will not
+run again (but it will log something if you have set
+@code{auth-source-debug} to @code{'trivia}). This is so it won't ask
+the same question again, which is annoying. This is so it won't ask
+the same question again, which is annoying. This is so it won't ask
+the same question again, which is annoying.
+
+So the responsibility of the API user that specified @code{:create t}
+is to call the @code{:save-function} if it's provided.
+
@defun auth-source-delete SPEC
TODO: how to include docstring?