From 717f917d1de5272d6c24e8a32af1cc698989c41e Mon Sep 17 00:00:00 2001 From: "F. Jason Park" Date: Mon, 18 Dec 2023 19:38:30 -0800 Subject: [PATCH] ; 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. --- lisp/erc/erc-networks.el | 2 -- lisp/erc/erc.el | 15 +++++++++------ test/lisp/erc/erc-tests.el | 2 +- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/lisp/erc/erc-networks.el b/lisp/erc/erc-networks.el index 694f56ed0d5..590f1e88660 100644 --- a/lisp/erc/erc-networks.el +++ b/lisp/erc/erc-networks.el @@ -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)) diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index faa2cbefd1b..7071d8ca2d7 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -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)) diff --git a/test/lisp/erc/erc-tests.el b/test/lisp/erc/erc-tests.el index 45cf4ea489f..8a28d351b0f 100644 --- a/test/lisp/erc/erc-tests.el +++ b/test/lisp/erc/erc-tests.el @@ -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) -- 2.39.2