]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add note on memory usage to LZMACompressor doc.
authorNadeem Vawda <nadeem.vawda@gmail.com>
Mon, 2 Jan 2012 00:24:20 +0000 (02:24 +0200)
committerNadeem Vawda <nadeem.vawda@gmail.com>
Mon, 2 Jan 2012 00:24:20 +0000 (02:24 +0200)
Doc/library/lzma.rst

index 4e6db15a74f99d3a677cae1888e3fc49bb3c1cb2..3941ec18d07c64e09142d10bb8c00bab2a544bdd 100644 (file)
@@ -120,8 +120,16 @@ Compressing and decompressing data in memory
    ``9`` (inclusive), optionally OR-ed with the constant
    :const:`PRESET_EXTREME`. If neither *preset* nor *filters* are given, the
    default behavior is to use :const:`PRESET_DEFAULT` (preset level ``6``).
-   Higher presets produce smaller output, but make compression more CPU- and
-   memory-intensive, and also increase the memory required for decompression.
+   Higher presets produce smaller output, but make the compression process
+   slower.
+
+   .. note::
+
+      In addition to being more CPU-intensive, compression with higher presets
+      also requires much more memory (and produces output that needs more memory
+      to decompress). With preset ``9`` for example, the overhead for an
+      :class:`LZMACompressor` object can be as high as 800MiB. For this reason,
+      it is generally best to stick with the default preset.
 
    The *filters* argument (if provided) should be a filter chain specifier.
    See :ref:`filter-chain-specs` for details.