diff options
| author | F. Jason Park | 2022-11-30 23:10:58 -0800 |
|---|---|---|
| committer | F. Jason Park | 2022-12-14 06:40:55 -0800 |
| commit | 9ac80e8a6e4969cfe88d5233dc4152bbfa46c848 (patch) | |
| tree | cd44b91bd46448e66e66c9cbbed0dc07cb58c2d6 /lisp | |
| parent | 2d96a18cd09be1c53b1242be1e0671cfc5b7fa8c (diff) | |
| download | emacs-9ac80e8a6e4969cfe88d5233dc4152bbfa46c848.tar.gz emacs-9ac80e8a6e4969cfe88d5233dc4152bbfa46c848.zip | |
Add dedicated auth-source section in ERC manual
* doc/misc/erc.texi: Move auth-source description from the Password
subheading of the Advanced chapter's Connecting section to the new
Integrations section as a new node, Auth-Source, and give it a bit
more structure. Fix various misuses of xref vs. pxref. Convert URL
subheading to subsection and add anchor. Prefer "backend" as a single
word, based on usage in other manuals. Also replace loud "warning" in
SASL troubleshooting section.
* etc/ERC-NEWS: Re-link auth-source mention.
* lisp/erc/erc-sasl.el (erc-sasl-auth-source-function): Update info
node in doc string.
* lisp/erc/erc-services.el (erc-auth-source-services-function):
Re-link auth-source info node in doc string.
* lisp/erc/erc.el (erc-password, erc-auth-source-server-function,
erc-auth-source-join-function): Re-link auth-source info node in doc
strings.
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/erc/erc-sasl.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-services.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc.el | 6 |
3 files changed, 5 insertions, 5 deletions
diff --git a/lisp/erc/erc-sasl.el b/lisp/erc/erc-sasl.el index 5b2c93988af..280910111d5 100644 --- a/lisp/erc/erc-sasl.el +++ b/lisp/erc/erc-sasl.el | |||
| @@ -102,7 +102,7 @@ ERC binds all options defined in this library, such as | |||
| 102 | `erc-sasl-password', to their values from entry-point invocation. | 102 | `erc-sasl-password', to their values from entry-point invocation. |
| 103 | In return, ERC expects a string to send as the SASL password, or | 103 | In return, ERC expects a string to send as the SASL password, or |
| 104 | nil, in which case, ERC will prompt the for input. See info | 104 | nil, in which case, ERC will prompt the for input. See info |
| 105 | node `(erc) Connecting' for details on ERC's auth-source | 105 | node `(erc) auth-source' for details on ERC's auth-source |
| 106 | integration." | 106 | integration." |
| 107 | :type '(choice (function-item erc-sasl-auth-source-password-as-host) | 107 | :type '(choice (function-item erc-sasl-auth-source-password-as-host) |
| 108 | (function-item erc-auth-source-search) | 108 | (function-item erc-auth-source-search) |
diff --git a/lisp/erc/erc-services.el b/lisp/erc/erc-services.el index 48953288d17..c2d91ca9d65 100644 --- a/lisp/erc/erc-services.el +++ b/lisp/erc/erc-services.el | |||
| @@ -180,7 +180,7 @@ Called with a subset of keyword parameters known to | |||
| 180 | `auth-source-search' and relevant to authenticating to nickname | 180 | `auth-source-search' and relevant to authenticating to nickname |
| 181 | services. In return, ERC expects a string to send as the | 181 | services. In return, ERC expects a string to send as the |
| 182 | password, or nil, to fall through to the next method, such as | 182 | password, or nil, to fall through to the next method, such as |
| 183 | prompting. See info node `(erc) Connecting' for details." | 183 | prompting. See info node `(erc) auth-source' for details." |
| 184 | :package-version '(ERC . "5.4.1") ; FIXME update when publishing to ELPA | 184 | :package-version '(ERC . "5.4.1") ; FIXME update when publishing to ELPA |
| 185 | :type '(choice (const erc-auth-source-search) | 185 | :type '(choice (const erc-auth-source-search) |
| 186 | (const nil) | 186 | (const nil) |
diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 6bb2e013c3b..3b0cde41558 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el | |||
| @@ -219,7 +219,7 @@ parameters and authentication." | |||
| 219 | This variable only exists for legacy reasons. It's not customizable and | 219 | This variable only exists for legacy reasons. It's not customizable and |
| 220 | is limited to a single server password. Users looking for similar | 220 | is limited to a single server password. Users looking for similar |
| 221 | functionality should consider auth-source instead. See info | 221 | functionality should consider auth-source instead. See info |
| 222 | node `(auth) Top' and info node `(erc) Connecting'.") | 222 | node `(auth) Top' and info node `(erc) auth-source'.") |
| 223 | 223 | ||
| 224 | (make-obsolete-variable 'erc-password "use auth-source instead" "29.1") | 224 | (make-obsolete-variable 'erc-password "use auth-source instead" "29.1") |
| 225 | 225 | ||
| @@ -3208,7 +3208,7 @@ if any. In return, ERC expects a string to send as the server | |||
| 3208 | password, or nil, to skip the \"PASS\" command completely. An | 3208 | password, or nil, to skip the \"PASS\" command completely. An |
| 3209 | explicit `:password' argument to entry-point commands `erc' and | 3209 | explicit `:password' argument to entry-point commands `erc' and |
| 3210 | `erc-tls' also inhibits lookup, as does setting this option to | 3210 | `erc-tls' also inhibits lookup, as does setting this option to |
| 3211 | nil. See info node `(erc) Connecting' for details." | 3211 | nil. See info node `(erc) auth-source' for details." |
| 3212 | :package-version '(ERC . "5.4.1") ; FIXME update when publishing to ELPA | 3212 | :package-version '(ERC . "5.4.1") ; FIXME update when publishing to ELPA |
| 3213 | :group 'erc | 3213 | :group 'erc |
| 3214 | :type '(choice (const erc-auth-source-search) | 3214 | :type '(choice (const erc-auth-source-search) |
| @@ -3223,7 +3223,7 @@ channel. In return, ERC expects a string to use as the channel | |||
| 3223 | \"key\", or nil to just join the channel normally. Setting the | 3223 | \"key\", or nil to just join the channel normally. Setting the |
| 3224 | option itself to nil tells ERC to always forgo consulting | 3224 | option itself to nil tells ERC to always forgo consulting |
| 3225 | auth-source for channel keys. For more information, see info | 3225 | auth-source for channel keys. For more information, see info |
| 3226 | node `(erc) Connecting'." | 3226 | node `(erc) auth-source'." |
| 3227 | :package-version '(ERC . "5.4.1") ; FIXME update when publishing to ELPA | 3227 | :package-version '(ERC . "5.4.1") ; FIXME update when publishing to ELPA |
| 3228 | :group 'erc | 3228 | :group 'erc |
| 3229 | :type '(choice (const erc-auth-source-search) | 3229 | :type '(choice (const erc-auth-source-search) |