diff options
| author | Damien Cassou | 2021-06-27 17:38:59 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2021-07-02 12:53:35 +0200 |
| commit | aad2e698077eb5cf658c36c5728c5ee36d598d23 (patch) | |
| tree | 521d652d60476ec5a8cf5cbc3a1f9ec2a4fc14ad | |
| parent | b09ee1406205e8b6298411b9a18c1cd26e201689 (diff) | |
| download | emacs-aad2e698077eb5cf658c36c5728c5ee36d598d23.tar.gz emacs-aad2e698077eb5cf658c36c5728c5ee36d598d23.zip | |
; * lisp/auth-source-pass.el: Improve docstrings
| -rw-r--r-- | lisp/auth-source-pass.el | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/lisp/auth-source-pass.el b/lisp/auth-source-pass.el index 6e33970486d..0f8be84dc2d 100644 --- a/lisp/auth-source-pass.el +++ b/lisp/auth-source-pass.el | |||
| @@ -60,11 +60,10 @@ | |||
| 60 | (cl-defun auth-source-pass-search (&rest spec | 60 | (cl-defun auth-source-pass-search (&rest spec |
| 61 | &key backend type host user port | 61 | &key backend type host user port |
| 62 | &allow-other-keys) | 62 | &allow-other-keys) |
| 63 | "Given a property list SPEC, return search matches from the :backend. | 63 | "Given some search query, return matching credentials. |
| 64 | See `auth-source-search' for details on SPEC. | ||
| 65 | 64 | ||
| 66 | HOST can be a string or a list of strings, but USER and PORT are expected | 65 | See `auth-source-search' for details on the parameters SPEC, BACKEND, TYPE, |
| 67 | to be a string only." | 66 | HOST, USER and PORT." |
| 68 | (cl-assert (or (null type) (eq type (oref backend type))) | 67 | (cl-assert (or (null type) (eq type (oref backend type))) |
| 69 | t "Invalid password-store search: %s %s") | 68 | t "Invalid password-store search: %s %s") |
| 70 | (cond ((eq host t) | 69 | (cond ((eq host t) |
| @@ -126,7 +125,7 @@ ENTRY is the name of a password-store entry. | |||
| 126 | The key used to retrieve the password is the symbol `secret'. | 125 | The key used to retrieve the password is the symbol `secret'. |
| 127 | 126 | ||
| 128 | The convention used as the format for a password-store file is | 127 | The convention used as the format for a password-store file is |
| 129 | the following (see https://www.passwordstore.org/#organization): | 128 | the following (see URL `https://www.passwordstore.org/#organization'): |
| 130 | 129 | ||
| 131 | secret | 130 | secret |
| 132 | key1: value1 | 131 | key1: value1 |
| @@ -278,7 +277,7 @@ If ENTRIES is nil, use the result of calling `auth-source-pass-entries' instead. | |||
| 278 | (defun auth-source-pass--generate-entry-suffixes (hostname user port) | 277 | (defun auth-source-pass--generate-entry-suffixes (hostname user port) |
| 279 | "Return a list of possible entry path suffixes in the password-store. | 278 | "Return a list of possible entry path suffixes in the password-store. |
| 280 | 279 | ||
| 281 | Based on the supported pathname patterns for HOSTNAME, USER, & | 280 | Based on the supported filename patterns for HOSTNAME, USER, & |
| 282 | PORT, return a list of possible suffixes for matching entries in | 281 | PORT, return a list of possible suffixes for matching entries in |
| 283 | the password-store. | 282 | the password-store. |
| 284 | 283 | ||
| @@ -326,3 +325,5 @@ then NAME & USER, then NAME & PORT, then just NAME." | |||
| 326 | 325 | ||
| 327 | (provide 'auth-source-pass) | 326 | (provide 'auth-source-pass) |
| 328 | ;;; auth-source-pass.el ends here | 327 | ;;; auth-source-pass.el ends here |
| 328 | |||
| 329 | ;; LocalWords: backend hostname | ||