Skip to content

Update documentation about LZO and LZ4 modules #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update documentation about LZO and LZ4 modules #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3507cc6
Update documentation about LZO and LZ4 modules
Schamper Jun 26, 2025
67f4808
Update docs/source/projects/dissect.util/index.rst
Schamper Jun 27, 2025
e1d71e1
Apply suggestions from code review
Schamper Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions docs/source/projects/dissect.btrfs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down
16 changes: 4 additions & 12 deletions docs/source/projects/dissect.squashfs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,10 @@ 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.
Pre-build wheels are available for most common platforms and the native implementation will automatically be used if available.
In the rare case that a pre-build wheel is not available, please refer to :doc:`/projects/dissect.util/index` for build instructions.

Usage
-----
Expand Down
12 changes: 5 additions & 7 deletions docs/source/projects/dissect.util/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,15 @@ 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 if available.
In the rare case that a pre-build wheel is not available, you can build a wheel for your platform 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
-----
Expand Down