Skip to content

Conversation

@shymega-ct
Copy link
Contributor

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.

@shymega-ct shymega-ct force-pushed the domrodriguez/add-linux-disclaimer-docs branch 4 times, most recently from 3a6fa03 to 87840db Compare September 17, 2025 14:44
@shymega-ct shymega-ct marked this pull request as draft September 17, 2025 14:44
@shymega-ct shymega-ct force-pushed the domrodriguez/add-linux-disclaimer-docs branch from 87840db to 95bda47 Compare September 18, 2025 20:08
@shymega-ct shymega-ct marked this pull request as ready for review September 18, 2025 20:09
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.
Copy link
Contributor

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."

@jjardon
Copy link
Contributor

jjardon commented Oct 15, 2025

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?

@shymega-ct
Copy link
Contributor Author

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.

@shymega-ct shymega-ct force-pushed the domrodriguez/add-linux-disclaimer-docs branch from 95bda47 to 6ead3bd Compare November 3, 2025 19:29
@cs-shadow
Copy link
Member

I think this add a line about windows not being officially supported but It's not very clear about what OSes are actually supported ...

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)

... (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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants