File 0516-zlib-Document-default-compression-level.patch of Package erlang
From 39fc6508e3cbc441390ae14e362e8a83ad98daa3 Mon Sep 17 00:00:00 2001
From: Wojtek Mach <wojtek@wojtekmach.pl>
Date: Sun, 21 Mar 2021 12:27:06 +0100
Subject: [PATCH] zlib: Document 'default' compression level
---
erts/doc/src/zlib.xml | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/erts/doc/src/zlib.xml b/erts/doc/src/zlib.xml
index 7b471bb95c..5d3fb9d8eb 100644
--- a/erts/doc/src/zlib.xml
+++ b/erts/doc/src/zlib.xml
@@ -59,7 +59,7 @@ list_to_binary([Compressed|Last])</pre>
<p>In all functions errors, <c>{'EXIT',{Reason,Backtrace}}</c>,
can be thrown, where <c>Reason</c> describes the error.</p>
- <p>Typical <c>Reasons</c>s:</p>
+ <p>Typical <c>Reason</c>s:</p>
<taglist>
<tag><c>badarg</c></tag>
@@ -326,9 +326,10 @@ list_to_binary([B1,B2])</pre>
<p><c><anno>Level</anno></c> decides the compression level to be
used:</p>
<list type="bulleted">
- <item>0 (<c>none</c>), gives no compression</item>
- <item>1 (<c>best_speed</c>) gives best speed</item>
- <item>9 (<c>best_compression</c>) gives best compression</item>
+ <item><c>default</c> gives default compromise between speed and compression</item>
+ <item><c>none</c> (0) gives no compression</item>
+ <item><c>best_speed</c> (1) gives best speed</item>
+ <item><c>best_compression</c> (9) gives best compression</item>
</list>
</desc>
</func>
@@ -343,9 +344,10 @@ list_to_binary([B1,B2])</pre>
<item>
<p>Compression level to use:</p>
<list type="bulleted">
- <item>0 (<c>none</c>), gives no compression</item>
- <item>1 (<c>best_speed</c>) gives best speed</item>
- <item>9 (<c>best_compression</c>) gives best compression</item>
+ <item><c>default</c> gives default compromise between speed and compression</item>
+ <item><c>none</c> (0) gives no compression</item>
+ <item><c>best_speed</c> (1) gives best speed</item>
+ <item><c>best_compression</c> (9) gives best compression</item>
</list>
</item>
<tag><c><anno>Method</anno></c></tag>
--
2.26.2