branch: externals/auth-source-xoauth2-plugin
commit 44c6f97abced1780eaa92f028ac8d9a88f89dbb2
Author: Xiyue Deng <manp...@gmail.com>
Commit: Xiyue Deng <manp...@gmail.com>
Add a section for debugging
---
README.org | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/README.org b/README.org
index 7af818583e..97a3b0d568 100644
--- a/README.org
+++ b/README.org
@@ -111,6 +111,29 @@ reimplemented most of the required functions itself.
storage for storing temporary/ephemeral data tokens, where
`auth-source-xoauth2' implemented its own storage.
+* Debugging
+
+In case you encounter any issues, you may consider enabling verbose
+messages to help debugging. `auth-source-xoauth2-plugin' uses the
+same convention as `auth-source' for outputing verbose messages. You
+may do the following:
+
+#+BEGIN_SRC emacs-lisp
+ (setq auth-source-debug t)
+#+END_SRC
+
+and check the =*Message*= buffer for logs. You can enable even more
+verbose log by the following:
+
+#+BEGIN_SRC emacs-lisp
+ (setq auth-source-debug 'trivia)
+#+END_SRC
+
+NOTE: \'trivia will include your tokens for authentication in your
+=*Message*= buffer so be careful not to share the log with untrusted
+entities.
+
+
* Notes on Implementation
Currently the auth-source requires the searched entry must have
