@@ -31,11 +31,11 @@ python-isal
31
31
===========
32
32
33
33
Faster zlib and gzip compatible compression and decompression
34
- by providing python bindings for the isa-l library.
34
+ by providing Python bindings for the ISA-L library.
35
35
36
- This package provides Python bindings for the `isa-l
36
+ This package provides Python bindings for the `ISA-L
37
37
<https://github.com/intel/isa-l> `_ library. The Intel Infrastructure Storage
38
- Acceleration Library (isa-l ) implements several key algorithms in `assembly
38
+ Acceleration Library (ISA-L ) implements several key algorithms in `assembly
39
39
language <https://en.wikipedia.org/wiki/Assembly_language> `_. This includes
40
40
a variety of functions to provide zlib/gzip-compatible compression.
41
41
@@ -60,13 +60,13 @@ The latest development version of python-isal can be installed with::
60
60
61
61
pip install git+https://github.com/rhpvorderman/python-isal.git
62
62
63
- isa-l is available in numerous Linux distro's as well as on conda via the
63
+ ISA-L is available in numerous Linux distro's as well as on conda via the
64
64
conda-forge channel. Checkout the `ports documentation
65
- <https://github.com/intel/isa-l/wiki/Ports--Repos> `_ on the isa-l project wiki
65
+ <https://github.com/intel/isa-l/wiki/Ports--Repos> `_ on the ISA-L project wiki
66
66
to find out how to install it. It is important that the development headers
67
67
are also installed.
68
68
69
- On debian and ubuntu the isa-l libraries (including the development headers)
69
+ On Debian and Ubuntu the ISA-L libraries (including the development headers)
70
70
can be installed with:
71
71
72
72
.. code-block ::
@@ -121,7 +121,7 @@ Differences with zlib and gzip modules
121
121
122
122
+ Compression level 0 in ``zlib `` and ``gzip `` means **no compression **, while
123
123
in ``isal_zlib `` and ``igzip `` this is the **lowest compression level **.
124
- This is a design choice that was inherited from the isa-l library.
124
+ This is a design choice that was inherited from the ISA-L library.
125
125
+ Compression levels range from 0 to 3, not 1 to 9.
126
126
+ ``isal_zlib.crc32 `` and ``isal_zlib.adler32 `` do not support negative
127
127
numbers for the value parameter.
0 commit comments