-
-
Notifications
You must be signed in to change notification settings - Fork 6.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update WSL2 watch limitation explanation #8939
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sapphi-red
added
documentation
Improvements or additions to documentation
windows only
feat: hmr
p2-nice-to-have
Not breaking anything but nice to have (priority)
labels
Jul 5, 2022
✅ Deploy Preview for vite-docs-main canceled.
|
The current detection somehow works with docker+wsl2, but it does not work with wsl2.
sapphi-red
force-pushed
the
feat/wsl2-watch-warning
branch
from
July 9, 2022 17:02
4249cb9
to
7ff0916
Compare
sapphi-red
changed the title
feat: warn if watcher is not working on WSL2
feat: warn if usePolling is not set and WSL2 is used
Jul 9, 2022
sapphi-red
changed the title
feat: warn if usePolling is not set and WSL2 is used
feat: warn if usePolling is not set on WSL2
Jul 9, 2022
bluwy
reviewed
Jul 10, 2022
Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com>
Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com>
bluwy
previously approved these changes
Jul 11, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Neat!
I reconsidered that the warning is too noisy and removed it. |
sapphi-red
changed the title
feat: warn if usePolling is not set on WSL2
docs: update WSL2 watch limitation explanation
Aug 11, 2022
sapphi-red
added
p1-chore
Doesn't change code behavior (priority)
and removed
p2-nice-to-have
Not breaking anything but nice to have (priority)
labels
Aug 11, 2022
bluwy
approved these changes
Aug 12, 2022
patak-dev
approved these changes
Aug 13, 2022
Maybe there could be an short entry in troubleshouting pointing to these sections too? Ah, I see there is already a section https://vitejs.dev/guide/troubleshooting.html#vite-does-not-detect-a-file-change |
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
feat: hmr
p1-chore
Doesn't change code behavior (priority)
windows only
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the following warning for WSL2 whenusePolling
is not set. I'm not sure if it is good to have this warning for all WSL2 users.Alsothis PR improves the document about that.This also applies to docker with WSL2 backend and docker running on WSL2 directly.
refs #4116
Additional context
At first I thought it is able to detect the case if file system watching works or not.
But after implemented that, I noticed that the document is not correct.
The current explanation is:
But actually it is:
The former one is possible to detect, but the latter one is not possible since Vite runs as a WSL2 process or Windows process.
We could start a powershell process from Vite but that won't work with Docker(WSL2 backend).
One way to implement is to show this warning if any file change was not detected after some time.
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
fixes #123
).