Skip to content

Commit dbb2cab

Browse files
authored
Update documentation about LZO and LZ4 modules (#85)
1 parent 753c25c commit dbb2cab

File tree

3 files changed

+10
-30
lines changed

3 files changed

+10
-30
lines changed

docs/source/projects/dissect.btrfs/index.rst

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,8 @@ Installation
1818
1919
$ pip install dissect.btrfs
2020
21-
This project decompresses lzo compressed file systems and can use the faster, native (C-based) lzo implementation when
22-
installed, instead of the slower pure Python implementation provided by :doc:`/projects/dissect.util/index`. To use
23-
these faster implementations, install the package with the lzo extra:
24-
25-
.. code-block:: console
26-
27-
$ pip install "dissect.btrfs[lzo]"
28-
29-
Unfortunately there is no binary ``python-lzo`` wheel for PyPy installations on Windows, so it won't be installed there.
30-
31-
This module including the lzo extra is also automatically installed if you install the ``dissect`` package.
21+
This project supports file systems with LZO compression. It can use either a fast Rust implementation, or a slow pure Python implementation. Both implementations are provided by :doc:`/projects/dissect.util/index`, and the faster implementation will automatically be used if available.
22+
Pre-build wheels are available for most common platforms. In the rare case that a pre-build wheel is not available, please refer to :doc:`/projects/dissect.util/index` for build instructions.
3223

3324
Usage
3425
-----

docs/source/projects/dissect.squashfs/index.rst

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,8 @@ Installation
1818
1919
$ pip install dissect.squashfs
2020
21-
This project decompresses lzo and lz4 compressed file systems and can use the faster, native (C-based) lzo and lz4
22-
implementations when installed, instead of the slower pure Python implementation provided by
23-
:doc:`/projects/dissect.util/index`. To use these faster implementations, install the package with the lzo and lz4
24-
extras:
25-
26-
.. code-block:: console
27-
28-
$ pip install "dissect.squashfs[lz4,lzo]"
29-
30-
Unfortunately there is no binary ``python-lzo`` wheel for PyPy installations on Windows, so it won't be installed there.
31-
32-
This module including the lz4 and lzo extras is also automatically installed if you install the ``dissect`` package.
21+
This project supports file systems with LZO and LZ4 compression. It can use either a fast Rust implementation, or a slow pure Python implementation. Both implementations are provided by :doc:`/projects/dissect.util/index`, and the faster implementation will automatically be used if available.
22+
Pre-build wheels are available for most common platforms. In the rare case that a pre-build wheel is not available, please refer to :doc:`/projects/dissect.util/index` for build instructions.
3323

3424
Usage
3525
-----

docs/source/projects/dissect.util/index.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,16 @@ Installation
2424
2525
$ pip install dissect.util
2626
27-
``dissect.util`` includes pure Python implementations of the lz4 and lzo decompression algorithms. To automatically use
28-
the faster, native (C-based) lz4 and lzo implementations in other dissect projects, install the package with the lz4 and
29-
lzo extras:
27+
``dissect.util`` includes both a pure Python implementation as well as a faster native Rust implementation of the LZ4 and LZO decompression algorithms.
28+
Pre-build wheels are available for most common platforms and the native implementation will automatically be used.
29+
In the rare case that a pre-build wheel is not available, the pure Python implementation will automatically be used instead.
30+
If you wish to build your own wheel in the case a pre-build one is not available for your platform, you can do so by running the following command:
3031

3132
.. code-block:: console
3233
33-
$ pip install "dissect.util[lz4,lzo]"
34+
$ tox -e build-native
3435
35-
Unfortunately there is no binary ``python-lzo`` wheel for PyPy installations on Windows, so it won't install there.
36-
37-
This module including the lz4 and lzo extras is also automatically installed if you install the ``dissect`` package.
36+
Note that you'll need to bring your own Rust toolchain for the target platform you wish to build a wheel for. For example, using [rustup](https://rustup.rs).
3837

3938
Usage
4039
-----

0 commit comments

Comments
 (0)