-
-
Notifications
You must be signed in to change notification settings - Fork 646
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
WSL disclaimer in Getting Started/Prerequisites #18000
WSL disclaimer in Getting Started/Prerequisites #18000
Conversation
pants doesn't work when invoked from a folder not inside the VM
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.
Thanks for updating the docs!
@@ -68,3 +68,9 @@ System-specific notes | |||
> - Install a recent Linux distribution under WSL 2 (we have tested with Ubuntu 20.04 LTS). | |||
> - Run `sudo apt install unzip python3-dev python3-distutils python3-venv gcc` in the distribution. | |||
> - You can then run Pants commands in a Linux shell, or in a Windows shell by prefixing with `wsl `. | |||
|
|||
> 🚧 Using WSL on Windows |
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.
Since we already have a callout for Windows, I think it's sufficient if we add this as another bullet point above?
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.
I agree! Will make the change
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.
Thanks!
@KadenAgrey can you merge latest |
Thanks @KadenAgrey |
A short disclaimer was added to inform new Windows users that their projects must live within the Linux virtual machine for Pants to work correctly.
Feedback welcome! In particular, I want to confirm that using the
wsl
prefix in a Windows shell has the same limitations. I will check myself in a few days if no one knows already.Related to discussion in #17986.