diff options
| author | Ivan Molodetskikh <yalterz@gmail.com> | 2025-05-22 11:33:50 +0300 |
|---|---|---|
| committer | Ivan Molodetskikh <yalterz@gmail.com> | 2025-05-22 11:35:12 +0300 |
| commit | c4a759e620dd6b21c5aba0b70139a39c44d855fc (patch) | |
| tree | 5a121f9ee4178335162ec100821537c6632cdf58 | |
| parent | f369a0f810710cfbbbc1e847cf2fc7f6392af31f (diff) | |
| download | niri-c4a759e620dd6b21c5aba0b70139a39c44d855fc.tar.gz niri-c4a759e620dd6b21c5aba0b70139a39c44d855fc.tar.bz2 niri-c4a759e620dd6b21c5aba0b70139a39c44d855fc.zip | |
wiki/packaging: Document limiting test threads
| -rw-r--r-- | wiki/Packaging-niri.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/wiki/Packaging-niri.md b/wiki/Packaging-niri.md index cbffeef1..5e0fe3e9 100644 --- a/wiki/Packaging-niri.md +++ b/wiki/Packaging-niri.md @@ -28,6 +28,20 @@ To do that, put files into the correct directories according to this table. Doing this will make niri appear in GDM and other display managers. +### Running tests + +A bulk of our tests spawn niri compositor instances and test Wayland clients. +This does not require a graphical session, however due to test parallelism, it can run into file descriptor limits on high core count systems. + +If you run into this problem, you may need to limit not just the Rust test harness thread count, but also the Rayon thread count, since some niri tests use internal Rayon threading: + +``` +$ export RAYON_NUM_THREADS=2 +...proceed to run cargo test, perhaps with --test-threads=2 +``` + +Don't forget to exclude the development-only `niri-visual-tests` crate when running tests. + ### Version string The niri version string includes its version and commit hash: |