diff options
| author | Ivan Molodetskikh <yalterz@gmail.com> | 2024-05-01 12:10:03 +0400 |
|---|---|---|
| committer | Ivan Molodetskikh <yalterz@gmail.com> | 2024-05-01 12:10:38 +0400 |
| commit | af9caa1d9b176fe3606323a8c05c0c741c1f6c0a (patch) | |
| tree | ac6a638af15dc97b9d1f7ac956bbc9effaf871e6 | |
| parent | 68ff36f6834beecf74b30a724ae3ef31874a3518 (diff) | |
| download | niri-af9caa1d9b176fe3606323a8c05c0c741c1f6c0a.tar.gz niri-af9caa1d9b176fe3606323a8c05c0c741c1f6c0a.tar.bz2 niri-af9caa1d9b176fe3606323a8c05c0c741c1f6c0a.zip | |
wiki: Warn against --all-features in getting started
| -rw-r--r-- | wiki/Getting-Started.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/wiki/Getting-Started.md b/wiki/Getting-Started.md index 3cac7c56..4cd416c9 100644 --- a/wiki/Getting-Started.md +++ b/wiki/Getting-Started.md @@ -95,6 +95,12 @@ Then, build niri with `cargo build --release`. Check Cargo.toml for a list of build features. For example, you can replace systemd integration with dinit integration using `cargo build --release --no-default-features --features dinit,dbus,xdp-gnome-screencast`. +> [!WARNING] +> Do NOT build with `--all-features`! +> +> Some features are meant only for development use. +> For example, one of the features enables collection of profiling data into a memory buffer that will grow indefinitely until you run out of memory. + ### NixOS/Nix We have a community-maintained flake which provides a devshell with required dependencies. Use `nix build` to build niri, and then run `./results/bin/niri`. |