docs/README: Add note to make OS requirement clear #2061
Conversation
shymega-ct
requested review from
BenjaminSchubert,
abderrahim,
cs-shadow,
gtristan and
juergbi
as code owners
README.rst
Outdated
| and then follow our tutorial in the | ||
| `user guide <https://docs.buildstream.build/master/main_using.html>`_. | ||
|
|
||
| Currently, Buildstream (and Buildbox) are only supported on arm64/x86_64 Linux machines. |
There was a problem hiding this comment.
I don't think this is accurate.
AFAIK, we're not doing anything Linux specific in BuildStream. It should work the same on any POSIX system.
Same for architecture, there is nothing arm64/x86_64 specific in BuildStream. I know for a fact that it is being used on PowerPC and RISC V architectures just fine. There is a limitation in what target architectures it can build for, but this is more due to the fact it uses the bazel remote APIs platform lexicon rather than something in buildstream itself.
As for the limitations of buildbox, I don't think this is the right place to document them. Yes buildbox-run-bubblewrap is linux specific, but there are other buildbox-run implementations.
Another important thing is that we may support different things for local builds and for remote execution, so we shouldn't just put everything in one basket.
There was a problem hiding this comment.
Ah, I should have kept the architecture out of that addition.
Especially as we know Buildbox runs even on s390x architectures.
I'll remove the Buildbox mention, and the arm64/x86_64 mention for
Buildstream; although I think we should minimise any further depth of
explanations about RECC and target architectures. Perhaps it might be
worth linking to a page in the docs?
There was a problem hiding this comment.
Nobody talked about RECC 😉
In that case, I don't see anything to add to this README. Unless you want to word it as "Windows is not supported" (and possibly mention WSL2)
There was a problem hiding this comment.
I've adjusted it in 95bda47 😄
shymega-ct
force-pushed
the
domrodriguez/add-linux-disclaimer-docs
branch
4 times, most recently
from
3a6fa03 to
87840db
Compare
shymega-ct
force-pushed
the
domrodriguez/add-linux-disclaimer-docs
branch
from
87840db to
95bda47
Compare
| and then follow our tutorial in the | ||
| `user guide <https://docs.buildstream.build/master/main_using.html>`_. | ||
|
|
||
| Running Buildstream on Windows is not supported, although WSL2 may result in |
There was a problem hiding this comment.
| Running Buildstream on Windows is not supported, although WSL2 may result in | |
| Running BuildStream on Windows is not supported, although WSL2 may result in |
| `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.
"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? |
4 participants
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.