COMPRESS-386 document new maxmemory setting
@@ -115,6 +115,18 @@ CompressorInputStream input = new CompressorStreamFactory()
enable the support.</p>
</subsection>
+ <subsection name="Restricting Memory Usage">
+ <p>Starting with Compress 1.14
+ <code>CompressorStreamFactory</code> has an optional
+ constructor argument that can be used to set an upper limit of
+ memory that may be used while decompressing or compressing a
+ stream. As of 1.14 this setting only affects decompressing Z,
+ XZ and LZMA compressed streams.</p>
+ <p>For the Snappy and LZ4 formats the amount of memory used
+ during compression is directly proportional to the window
+ size.</p>
+ </subsection>
+
<subsection name="ar">
<p>In addition to the information stored
