; Fix some doc strings in ERC

* lisp/erc/erc-networks.el: Lose some unneeded forward declarations.
* lisp/erc/erc.el (erc-open-socks-tls-stream): Don't conflate SOCKS
with TOR by mentioning a ".onion" address for the `host' parameter.
* test/lisp/erc/erc-tests.el
(erc--check-prompt-input-for-multiline-blanks): Extend timeout.
This commit is contained in:
F. Jason Park 2023-12-18 19:38:30 -08:00
parent 13182ae976
commit 717f917d1d
3 changed files with 10 additions and 9 deletions

View file

@ -54,9 +54,7 @@
(declare-function erc-current-nick "erc" nil)
(declare-function erc-display-error-notice "erc" (parsed string))
(declare-function erc-display-message "erc" (parsed type buffer msg &rest args))
(declare-function erc-error "erc" (&rest args))
(declare-function erc-get-buffer "erc" (target &optional proc))
(declare-function erc-server-buffer "erc" nil)
(declare-function erc-server-process-alive "erc-backend" (&optional buffer))
(declare-function erc-set-active-buffer "erc" (buffer))

View file

@ -2852,12 +2852,15 @@ PARAMETERS should be a sequence of keywords and values, per
(defun erc-open-socks-tls-stream (name buffer host service &rest parameters)
"Connect to an IRC server via SOCKS proxy over TLS.
Bind `erc-server-connect-function' to this function around calls
to `erc-tls'. See `erc-open-network-stream' for the meaning of
NAME and BUFFER. HOST should be a \".onion\" URL, SERVICE a TLS
port number, and PARAMETERS a sequence of key/value pairs, per
`open-network-stream'. See Info node `(erc) SOCKS' for more
info."
Defer to the `socks' and `gnutls' libraries to make the actual
connection and perform TLS negotiation. Expect SERVICE to be a
TLS port number and that the plist PARAMETERS contains a
`:client-certificate' pair when necessary. Otherwise, assume the
arguments NAME, BUFFER, and HOST to be acceptable to
`open-network-stream' and that users know to check out
`erc-server-connect-function' and Info node `(erc) SOCKS' for
more info, including an important example of how to \"wrap\" this
function with SOCKS credentials."
(require 'gnutls)
(require 'socks)
(let ((proc (socks-open-network-stream name buffer host service))

View file

@ -1520,7 +1520,7 @@
(ert-deftest erc--check-prompt-input-for-multiline-blanks ()
(erc-tests--with-process-input-spy
(lambda (next)
(erc-tests--set-fake-server-process "sleep" "1")
(erc-tests--set-fake-server-process "sleep" "10")
(should-not erc-send-whitespace-lines)
(should erc-warn-about-blank-lines)