alex/bcachefs-tools
1
0
Fork 0
mirror of https://github.com/koverstreet/bcachefs-tools.git synced 2025-01-22 00:04:31 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
5d892680cf
bcachefs-tools/INSTALL.md

79 lines
1.8 KiB
Markdown
Raw Normal View History

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-05 17:43:45 +03:00
Getting started
---------------
Build dependencies:
* libaio
* libblkid
docs: mention that libclang is required This fixes the following build failure on Debian bookworm: error: failed to run custom build command for `clang-sys v1.6.1` Caused by: process didn't exit successfully: `/home/minoru/src/bcachefs-tools/rust-src/target/release/build/clang-sys-df95f6d1266be773/build-script-build` (exit status: 101) --- stdout cargo:warning=could not execute `llvm-config` one or more times, if the LLVM_CONFIG_PATH environment variable is set to a full path to valid `llvm-config` executable it will be used to try to find an instance of `libclang` on your system: "couldn't execute `llvm-config --prefix` (path=llvm-config) (error: No such file or directory (os error 2))" --- stderr thread 'main' panicked at /home/minoru/.cargo/registry/src/index.crates.io-6f17d22bba15001f/clang-sys-1.6.1/build/dynamic.rs:206:45: called `Result::unwrap()` on an `Err` value: "couldn't find any valid shared libraries matching: ['libclang.so', 'libclang-*.so'], set the `LIBCLANG_PATH` environment variable to a path where one of these files can be found (invalid: [])" note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace Signed-off-by: Kent Overstreet <kent.overstreet@linux.dev>
2023-11-23 21:37:16 +03:00
* libclang
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-05 17:43:45 +03:00
* libkeyutils
* liblz4
* libsodium
* liburcu
* libuuid
* libzstd
* pkg-config
* valgrind
* zlib1g
In addition a recent Rust toolchain is required (rustc, cargo), either by using
ci: set and verify MSRV To prevent uncontrolled usage of new rust features, directly or from dependencies, set a minimum supported Rust version and verify it builds. Signed-off-by: Alexander Fougner <fougner89@gmail.com>
2023-07-21 12:41:54 +03:00
[rustup](https://rustup.rs/) or make sure to use a distribution where rustc (>=1.65)
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-05 17:43:45 +03:00
is available.
Debian (Bullseye or later) and Ubuntu (20.04 or later): you can install these with
``` shell
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 \
docs: mention that libclang is required This fixes the following build failure on Debian bookworm: error: failed to run custom build command for `clang-sys v1.6.1` Caused by: process didn't exit successfully: `/home/minoru/src/bcachefs-tools/rust-src/target/release/build/clang-sys-df95f6d1266be773/build-script-build` (exit status: 101) --- stdout cargo:warning=could not execute `llvm-config` one or more times, if the LLVM_CONFIG_PATH environment variable is set to a full path to valid `llvm-config` executable it will be used to try to find an instance of `libclang` on your system: "couldn't execute `llvm-config --prefix` (path=llvm-config) (error: No such file or directory (os error 2))" --- stderr thread 'main' panicked at /home/minoru/.cargo/registry/src/index.crates.io-6f17d22bba15001f/clang-sys-1.6.1/build/dynamic.rs:206:45: called `Result::unwrap()` on an `Err` value: "couldn't find any valid shared libraries matching: ['libclang.so', 'libclang-*.so'], set the `LIBCLANG_PATH` environment variable to a path where one of these files can be found (invalid: [])" note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace Signed-off-by: Kent Overstreet <kent.overstreet@linux.dev>
2023-11-23 21:37:16 +03:00
python3 python3-docutils libclang-dev
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-05 17:43:45 +03:00
```
Fedora: install the "Development tools" group along with:
```shell
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
```shell
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):
```shell
apt install -y libfuse3-dev
```
On Fedora (32 or later needed for lbifuse >= 3.7):
```shell
dnf install -y fuse3-devel
```
Arch:
```shell
pacman -S fuse3
```
Then, make using the `BCACHEFS_FUSE` environment variable (make clean first if
previously built without fuse support):
```shell
BCACHEFS_FUSE=1 make && make install
```
Reference in New Issue Copy Permalink