Skip to content
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

feat: Remove (or allow suppression of) WSL warning #8820

Closed
bradwilson opened this issue Sep 21, 2021 · 2 comments · Fixed by #8821
Closed

feat: Remove (or allow suppression of) WSL warning #8820

bradwilson opened this issue Sep 21, 2021 · 2 comments · Fixed by #8821
Labels
feature frozen-due-to-age has-pull-request Somebody suggested a solution to fix this issue

Comments

@bradwilson
Copy link

Summary

When running jekyll serve -w on Linux in WSL, I see this warning:

Auto-regeneration may not work on some Windows versions.
Please see: https://github.com/Microsoft/BashOnWindows/issues/216
If it does not work, please upgrade Bash on Windows or run Jekyll with --no-watch.

Looking at the source, it appears there's no way for me to suppress this message.

Motivation

This message is based on a bug that was fixed in 2016. I'm not sure whether there are any users it would still be relevant for, assuming people are taking advantage of their free Windows 10 upgrades (and let's all hope they are, because of security issues). The versions of Windows 10 where this bug would apply are no longer supported by Microsoft.

Some options include:

  1. Simply remove the message. The likelihood of it being relevant to anybody is vanishingly small.
  2. Attempt to detect the versions of WSL for which this is applicable and only show the message then.
  3. Provide us a way to opt out of the message (via an environment variable, ideally)

Drawbacks

  • For option 1, I don't have the stats handy to know how many jekyll users are using an old enough version of WSL to be affected by this bug. I'm using a gut feel here to say it's likely next to none.
  • For option 2, I haven't done the research to determine if you could easily detect this situation. The referenced bug would imply that simply looking for the existence of /proc/sys/fs/inotify/ would likely be good enough. It may also be difficult or impossible to get an old enough version of Windows 10 to verify this fix.
  • For option 3, although I would personally hunt this env var down and set it (😁) it would still be pretty hidden, unless you also mention the env var in the warning message.

Obviously option 1 is the simplest the implement. Option 2 feels like the next best option, but the most work (because of verification, not coding). Option 3 is a fairly simple and safe workaround that only requires a bit of code and doesn't depend on verification.

Doing nothing is the safest option, but the saddest one for me personally. 😉

@mattr-
Copy link
Member

mattr- commented Sep 22, 2021

I think the ideal solution is to go with option 1.

@bradwilson
Copy link
Author

@mattr- Fancy meeting you here! 😄

@jekyllbot jekyllbot added the has-pull-request Somebody suggested a solution to fix this issue label Sep 23, 2021
@jekyll jekyll locked and limited conversation to collaborators Sep 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature frozen-due-to-age has-pull-request Somebody suggested a solution to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants