docs: add a note on how to fix WSL2 watch issues (#4478)

vitejs · Aug 2, 2021 · d53dc92 · d53dc92
1 parent 59841f0
commit d53dc92
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -453,6 +453,8 @@ export default defineConfig(async ({ command, mode }) => {
 
   File system watcher options to pass on to [chokidar](https://github.com/paulmillr/chokidar#api).
 
+  When running Vite on Windows Subsystem for Linux (WSL) 2, if the project folder resides in a Windows filesystem, you'll need to set this option to `{ usePolling: true }`. This is due to [a WSL2 limitation](https://github.com/microsoft/WSL/issues/4739) with the Windows filesystem.
+
 ### server.middlewareMode
 
 - **Type:** `'ssr' | 'html'`