File 1441-ssh-small-alive-docs-improvements.patch of Package erlang
From 7a3ca4282879c2fcb0e695a7b3d830f869fe1441 Mon Sep 17 00:00:00 2001
From: Alexandre Rodrigues <alexandrejbr@live.com>
Date: Wed, 22 Oct 2025 14:01:11 +0200
Subject: [PATCH 11/20] ssh: small alive docs improvements
---
lib/ssh/src/ssh.hrl | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/lib/ssh/src/ssh.hrl b/lib/ssh/src/ssh.hrl
index d3517bab36..142048ecda 100644
--- a/lib/ssh/src/ssh.hrl
+++ b/lib/ssh/src/ssh.hrl
@@ -549,12 +549,11 @@ from the peer. If this threshold is reached the connection will be terminated.
The second value of the tuple sets the timeout interval, in seconds, after which, if no data
has been received from the peer, a message to request a response from the peer is sent.
-The default is {3, infinity}, which means that alive messages will not be sent to the peer,
+The default is `{3, infinity}`, which means that alive messages will not be sent to the peer,
since the `AliveInterval` is set to `infinity`.
No alive messages are sent during renegotiation, however, a timeout derived from the alive parameters
-is set to ensure that if the connection becomes unresponsive during renegotiation, the client/server
-disconnect.
+is set to ensure that unresponsive connections are terminated.
""".
-doc(#{group => <<"Common Options">>}).
-type alive_common_option() :: {alive_params, {AliveCountMax::pos_integer(), AliveInterval::timeout()}}.
--
2.51.0