Repository: commons-compress Updated Branches: refs/heads/master 508be17bb -> 6dc03d613
COMPRESS-382 COMPRESS-386 document new maxmemory setting Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/6dc03d61 Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/6dc03d61 Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/6dc03d61 Branch: refs/heads/master Commit: 6dc03d613c3620b78f544fa4a7c349b16b190354 Parents: 508be17 Author: Stefan Bodewig <bode...@apache.org> Authored: Sat Apr 29 16:22:15 2017 +0200 Committer: Stefan Bodewig <bode...@apache.org> Committed: Sat Apr 29 16:22:15 2017 +0200 ---------------------------------------------------------------------- src/site/xdoc/examples.xml | 12 ++++++++++++ 1 file changed, 12 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-compress/blob/6dc03d61/src/site/xdoc/examples.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/examples.xml b/src/site/xdoc/examples.xml index 4d928a8..16eb2a2 100644 --- a/src/site/xdoc/examples.xml +++ b/src/site/xdoc/examples.xml @@ -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
