Skip to content

Commit dd381f4

Browse files
committed
add a warning about the required linux kernel version for build on save
1 parent 0c9c800 commit dd381f4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

content/zls/guides/build-on-save.smd

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@
99

1010
ZLS can be configured to run your build script on save. If that results in build errors, they will be displayed in your editor like any other diagnostic.
1111

12+
># [Warning (Linux)]($block.attrs('warning'))
13+
>
14+
> On Linux, Build-On-Save requires a kernel version of at least `6.5`. Use `uname -r` to check your version. If an incompatible version is used, a warning will be [logged](/zls/guides/view-logs/) and Build-On-Save will be disabled.
15+
> A workaround implementation is available if `enable_build_on_save` has been set to `true`.
16+
>
17+
> This is especially important to WSL2 (Windows Subsystem for Linux version 2) users where the default kernel version is `5.15` as of January 2025.
18+
1219
## Configuration
1320

1421
By default, ZLS will automatically enable Build-On-Save if your build script defines a "check" step. Otherwise you will need to set the `enable_build_on_save` config option.

0 commit comments

Comments
 (0)