-
Notifications
You must be signed in to change notification settings - Fork 39
docs/README: Add note to make OS requirement clear #2061
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
base: master
Are you sure you want to change the base?
docs/README: Add note to make OS requirement clear #2061
Conversation
3a6fa03 to
87840db
Compare
87840db to
95bda47
Compare
README.rst
Outdated
| `user guide <https://docs.buildstream.build/master/main_using.html>`_. | ||
|
|
||
| Running Buildstream on Windows is not supported, although WSL2 may result in | ||
| some success; this workflow however, is not officially supporetd. |
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.
"may result in some success" is too unclear to me. WSL2 is essentially just Linux in a VM (+ a lot of integration work) and I would expect BuildStream to work fine in WSL2 but haven't tested it myself.
If there are known issues with BuildStream in WSL2, I would be less vague. If there are no known issues, I might formulate it something like:
"Running BuildStream on Windows is not supported. WSL2 may be used but is also not officially supported."
|
I think this add a line about windows not being officially supported but It's not very clear about what OSes are actually supported (my understanding is only Linux but I might be wrong) Can we be more clear about that, please? |
I believe it's Linux-only, but WSL2 is an instance of Linux in a VM, so I think @juergbi's suggestion works well. |
95bda47 to
6ead3bd
Compare
I concur, and would also suggest to phrase it in the positive direction of what's supported as opposed to enumerating what's not supported (which can be a never-ending list)
I believe Linux is the only thing that we test on and where BuildStream is used in earnest. In the past, there were weak attempts to make it work on MacOS and Windows to varying degrees but I don't think either of those work today in a meaningful way. Other than WSL, Docker Desktop (or Podman Desktop and such) can be a viable option in a similar "may be used but officially unsupported" category. The contrib/bst-here script was created to that end and can be potentially referenced here. |
This PR adds a note to the README to make the OS requirement clearer.
It might be that people think WSL2 can run Buildstream/Buildbox, and this has not yet been officially tested.