Skip to content
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

Document lack of Cygwin support #635

Closed
donatieng opened this issue Mar 7, 2018 · 7 comments
Closed

Document lack of Cygwin support #635

donatieng opened this issue Mar 7, 2018 · 7 comments
Assignees

Comments

@donatieng
Copy link

Although we have a couple of issues open (#578, #299) referencing this, there is no mention in the docs that Cygwin is not supported:
https://os.mbed.com/docs/v5.7/tools/installation-and-setup.html

It would be great having either a mention in the docs, or (better!) the platform being detected at runtime with a warning such as "running mbed-cli within Cygwin, use at your own risks!".

@cmonr
Copy link
Contributor

cmonr commented Mar 7, 2018

At the very bottom of README.md, this line exists:

"Currently Mbed CLI is not compatible with Cygwin environment and cannot be executed inside it (#299)."

Are we saying that we don't expect users to read the README, or that we should add more references around the codebase explicitly stating the Cygwin isn't supported?

@cmonr
Copy link
Contributor

cmonr commented Mar 7, 2018

Another option would be to somehow trim or split up the current README. Imo, it does seem quite long.

@theotherjimmy @screamerbg

@donatieng
Copy link
Author

Yes, it's very far down!
And there is no mention of it in the handbook.

@cmonr
Copy link
Contributor

cmonr commented Mar 8, 2018

@sg- @AnotherButler Looping y'all in.

@screamerbg
Copy link
Contributor

@cmonr Splitting the README might lead to another problem - "It's in the documentation but I couldn't find it (Ctrl+F)". Perhaps it's a question of shortening some of the Mbed CLI readme content @AnotherButler

Also agreed that this should be in the handbook @AnotherButler

@AnotherButler
Copy link
Contributor

This has been in the Handbook: https://os.mbed.com/docs/latest/tools/test-and-debug.html

@screamerbg
Copy link
Contributor

Closing this issue. Let's follow-up in #578 instead. In my environment Cygwin v2.10 (latest) for Windows 10 64bit, Mbed CLI works just fine.

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

No branches or pull requests

4 participants