alex/bcachefs-tools
1
0
Fork 0
mirror of https://github.com/koverstreet/bcachefs-tools.git synced 2025-02-09 00:00:04 +03:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
9690f78356
bcachefs-tools/INSTALL.md
Alexander Fougner ea8adaf1cc Update docs 
- add some project info for the main readme
- migrate readmes to markdown for improved formatting
- The main binary now requires the Rust toolchain, so make note of it
  in the build instructions.

Signed-off-by: Alexander Fougner <fougner89@gmail.com>
2023-03-07 12:46:53 -05:00

2.2 KiB
Raw Blame History

Getting started

Build dependencies:

  • libaio
  • libblkid
  • libkeyutils
  • liblz4
  • libsodium
  • liburcu
  • libuuid
  • libzstd
  • pkg-config
  • valgrind
  • zlib1g

In addition a recent Rust toolchain is required (rustc, cargo), either by using rustup or make sure to use a distribution where rustc (>=1.64) is available.

Debian (Bullseye or later) and Ubuntu (20.04 or later): you can install these with

apt install -y pkg-config libaio-dev libblkid-dev libkeyutils-dev \
    liblz4-dev libsodium-dev liburcu-dev libzstd-dev \
    uuid-dev zlib1g-dev valgrind libudev-dev git build-essential \
    python3 python3-docutils

Fedora: install the "Development tools" group along with:

dnf install -y libaio-devel libsodium-devel \
    libblkid-devel libzstd-devel zlib-devel userspace-rcu-devel \
    lz4-devel libuuid-devel valgrind-devel keyutils-libs-devel \
    findutils

Arch: install bcachefs-tools-git from the AUR. Or to build from source, install build dependencies with

pacman -S base-devel libaio keyutils libsodium liburcu zstd valgrind

Then, just make && make install

Experimental features

Experimental fuse support is currently disabled by default. Fuse support is at an early stage and may corrupt your filesystem, so it should only be used for testing. To enable, you'll also need to add:

  • libfuse3 >= 3.7

On Debian/Ubuntu (Bullseye/20.04 or later needed for libfuse >= 3.7):

apt install -y libfuse3-dev

On Fedora (32 or later needed for lbifuse >= 3.7):

dnf install -y fuse3-devel

Arch:

pacman -S fuse3

Then, make using the BCACHEFS_FUSE environment variable (make clean first if previously built without fuse support):

BCACHEFS_FUSE=1 make && make install

Tests

Some tests are available to validate the bcachefs binary. The tests depend on python3 pytest.

On debian:

apt install -u python3-pytest

Then, you can run the tests via:

make check
# or if pytest has a different name
make check PYTEST=pytest

Optionally, you may wish to run tests in parallel using python3-pytest-xdist:

cd tests; pytest-3 -n4