Re: [PR] docs/README: Add note to make OS requirement clear [buildstream]

["juergbi (via GitHub)" <gi...@apache.org>]

juergbi commented on code in PR #2061:
URL: https://github.com/apache/buildstream/pull/2061#discussion_r2418322733


##########
README.rst:
##########
@@ -110,6 +110,9 @@ To get started, first `install BuildStream by following the installation guide
 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

Review Comment:
   ```suggestion
     Running BuildStream on Windows is not supported, although WSL2 may result in
   ```



##########
README.rst:
##########
@@ -110,6 +110,9 @@ To get started, first `install BuildStream by following the installation guide
 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
+  some success; this workflow however, is not officially supporetd.

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



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org