File 5064-Adjust-documentation-to-mention-that-zlib-is-disable.patch of Package erlang
From c2d337b29d7f32e449dafad8a84c6ab358b5bdff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20W=C4=85sowski?= <michal@erlang.org>
Date: Sat, 7 Mar 2026 18:34:43 +0100
Subject: [PATCH 4/6] Adjust documentation to mention that zlib is disabled by
default
---
lib/ssh/doc/src/SSH_app.xml | 11 ++++++++++-
lib/ssh/doc/src/configurations.xml | 8 ++++----
lib/ssh/doc/src/configure_algos.xml | 25 +++++++++++++------------
lib/ssh/doc/src/ssh.xml | 2 +-
4 files changed, 28 insertions(+), 18 deletions(-)
diff --git a/lib/ssh/doc/src/SSH_app.xml b/lib/ssh/doc/src/SSH_app.xml
index 34c96ba074..31939975a9 100644
--- a/lib/ssh/doc/src/SSH_app.xml
+++ b/lib/ssh/doc/src/SSH_app.xml
@@ -275,8 +275,17 @@
<list type="bulleted">
<item>none</item>
<item>zlib@openssh.com</item>
- <item>zlib</item>
</list>
+ <p>The following compression algorithm is disabled by default:</p>
+ <list>
+ <item>(zlib)</item>
+ </list>
+ <p>It can be enabled with the
+ <seetype marker="ssh:ssh#preferred_algorithms_common_option">preferred_algorithms</seetype>
+ or
+ <seetype marker="ssh:ssh#modify_algorithms_common_option">modify_algorithms</seetype>
+ options.
+ </p>
</item>
</taglist>
</section>
diff --git a/lib/ssh/doc/src/configurations.xml b/lib/ssh/doc/src/configurations.xml
index 56dc84e7e0..87e2072abe 100644
--- a/lib/ssh/doc/src/configurations.xml
+++ b/lib/ssh/doc/src/configurations.xml
@@ -189,8 +189,8 @@ Eshell V10.6.4 (abort with ^G)
'hmac-sha1']},
{server2client,['hmac-sha2-256','hmac-sha2-512',
'hmac-sha1']}]},
- {compression,[{client2server,[none,'zlib@openssh.com',zlib]},
- {server2client,[none,'zlib@openssh.com',zlib]}]}]
+ {compression,[{client2server,[none,'zlib@openssh.com']},
+ {server2client,[none,'zlib@openssh.com']}]}]
</code>
<p>Note that the algorithms in the file <c>ex2.config</c> is not yet applied. They will be
when we start ssh:
@@ -205,8 +205,8 @@ ok
{server2client,['aes192-ctr']}]},
{mac,[{client2server,['hmac-sha1']},
{server2client,['hmac-sha1']}]},
- {compression,[{client2server,[none,'zlib@openssh.com',zlib]},
- {server2client,[none,'zlib@openssh.com',zlib]}]}]
+ {compression,[{client2server,[none,'zlib@openssh.com']},
+ {server2client,[none,'zlib@openssh.com']}]}]
4>
</code>
diff --git a/lib/ssh/doc/src/configure_algos.xml b/lib/ssh/doc/src/configure_algos.xml
index bbfbdb5e61..58e001e380 100644
--- a/lib/ssh/doc/src/configure_algos.xml
+++ b/lib/ssh/doc/src/configure_algos.xml
@@ -100,8 +100,9 @@
<tag><c>compression</c></tag>
<item>
- <p>If and how to compress the message. Examples are <c>none</c>, that is, no compression and
- <c>zlib</c>.</p>
+ <p>If and how to compress the message. Examples are <c>none</c>, that is, no compression,
+ <c>zlib</c> for pre-authentication compression (disabled by default), and <c>'zlib@openssh.com'</c>
+ for post-authentication compression.</p>
<p>This list is also divided into two for the both directions</p>
</item>
@@ -145,8 +146,8 @@
'hmac-sha1']},
{server2client,['hmac-sha2-256','hmac-sha2-512',
'hmac-sha1']}]},
- {compression,[{client2server,[none,'zlib@openssh.com',zlib]},
- {server2client,[none,'zlib@openssh.com',zlib]}]}]
+ {compression,[{client2server,[none,'zlib@openssh.com']},
+ {server2client,[none,'zlib@openssh.com']}]}]
</code>
<p>To change the algorithm list, there are two options which can be used in
@@ -196,8 +197,8 @@
'hmac-sha1']},
{server2client,['hmac-sha2-256','hmac-sha2-512',
'hmac-sha1']}]},
- {compression,[{client2server,[none,'zlib@openssh.com',zlib]},
- {server2client,[none,'zlib@openssh.com',zlib]}]}]
+ {compression,[{client2server,[none,'zlib@openssh.com']},
+ {server2client,[none,'zlib@openssh.com']}]}]
</code>
<p>Note that the unmentioned lists (<c>public_key</c>, <c>cipher</c>, <c>mac</c> and <c>compression</c>)
are un-changed.</p>
@@ -230,8 +231,8 @@
'hmac-sha1']},
{server2client,['hmac-sha2-256','hmac-sha2-512',
'hmac-sha1']}]},
- {compression,[{client2server,[none,'zlib@openssh.com',zlib]},
- {server2client,[none,'zlib@openssh.com',zlib]}]}]
+ {compression,[{client2server,[none,'zlib@openssh.com']},
+ {server2client,[none,'zlib@openssh.com']}]}]
</code>
<p>Note that both lists in <c>cipher</c> has been changed to the provided value (<c>'aes128-ctr'</c>).</p>
</section>
@@ -265,8 +266,8 @@
'hmac-sha1']},
{server2client,['hmac-sha2-256','hmac-sha2-512',
'hmac-sha1']}]},
- {compression,[{client2server,[none,'zlib@openssh.com',zlib]},
- {server2client,[none,'zlib@openssh.com',zlib]}]}]
+ {compression,[{client2server,[none,'zlib@openssh.com']},
+ {server2client,[none,'zlib@openssh.com']}]}]
</code>
</section>
@@ -353,8 +354,8 @@
'hmac-sha1']},
{server2client,['hmac-sha2-256','hmac-sha2-512',
'hmac-sha1']}]},
- {compression,[{client2server,[none,'zlib@openssh.com',zlib]},
- {server2client,[none,'zlib@openssh.com',zlib]}]}]
+ {compression,[{client2server,[none,'zlib@openssh.com']},
+ {server2client,[none,'zlib@openssh.com']}]}]
</code>
<p>And the result shows that the Diffie-Hellman Group1 is added at the head of the kex list</p>
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 7d3dfe2a51..e0c8cb5d37 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -1080,7 +1080,7 @@
{cipher,[{client2server,['aes128-ctr']},
{server2client,['aes128-cbc','3des-cbc']}]},
{mac,['hmac-sha2-256','hmac-sha1']},
- {compression,[none,zlib]}
+ {compression,[none,'zlib@openssh.com']}
]
}
</code>
--
2.51.0
