diff --git a/docs/source/projects/dissect.btrfs/index.rst b/docs/source/projects/dissect.btrfs/index.rst index 19d5499..53839ed 100644 --- a/docs/source/projects/dissect.btrfs/index.rst +++ b/docs/source/projects/dissect.btrfs/index.rst @@ -18,17 +18,8 @@ Installation $ pip install dissect.btrfs -This project decompresses lzo compressed file systems and can use the faster, native (C-based) lzo implementation when -installed, instead of the slower pure Python implementation provided by :doc:`/projects/dissect.util/index`. To use -these faster implementations, install the package with the lzo extra: - - .. code-block:: console - - $ pip install "dissect.btrfs[lzo]" - -Unfortunately there is no binary ``python-lzo`` wheel for PyPy installations on Windows, so it won't be installed there. - -This module including the lzo extra is also automatically installed if you install the ``dissect`` package. +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. +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. Usage ----- diff --git a/docs/source/projects/dissect.squashfs/index.rst b/docs/source/projects/dissect.squashfs/index.rst index 04e500c..090ad85 100644 --- a/docs/source/projects/dissect.squashfs/index.rst +++ b/docs/source/projects/dissect.squashfs/index.rst @@ -18,18 +18,8 @@ Installation $ pip install dissect.squashfs -This project decompresses lzo and lz4 compressed file systems and can use the faster, native (C-based) lzo and lz4 -implementations when installed, instead of the slower pure Python implementation provided by -:doc:`/projects/dissect.util/index`. To use these faster implementations, install the package with the lzo and lz4 -extras: - - .. code-block:: console - - $ pip install "dissect.squashfs[lz4,lzo]" - -Unfortunately there is no binary ``python-lzo`` wheel for PyPy installations on Windows, so it won't be installed there. - -This module including the lz4 and lzo extras is also automatically installed if you install the ``dissect`` package. +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. +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. Usage ----- diff --git a/docs/source/projects/dissect.util/index.rst b/docs/source/projects/dissect.util/index.rst index 188052f..9a0a320 100644 --- a/docs/source/projects/dissect.util/index.rst +++ b/docs/source/projects/dissect.util/index.rst @@ -24,17 +24,16 @@ Installation $ pip install dissect.util -``dissect.util`` includes pure Python implementations of the lz4 and lzo decompression algorithms. To automatically use -the faster, native (C-based) lz4 and lzo implementations in other dissect projects, install the package with the lz4 and -lzo extras: +``dissect.util`` includes both a pure Python implementation as well as a faster native Rust implementation of the LZ4 and LZO decompression algorithms. +Pre-build wheels are available for most common platforms and the native implementation will automatically be used. +In the rare case that a pre-build wheel is not available, the pure Python implementation will automatically be used instead. +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: .. code-block:: console - $ pip install "dissect.util[lz4,lzo]" + $ tox -e build-native -Unfortunately there is no binary ``python-lzo`` wheel for PyPy installations on Windows, so it won't install there. - -This module including the lz4 and lzo extras is also automatically installed if you install the ``dissect`` package. +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). Usage -----