Add warning about extreme path length limit on Windows #147
Conversation
This is a very surprising gotcha and kind of a pain to have to regenerate & recompile your project if you didn't know about it. Which you definitely didn't.
|
Actually cancel this. It's literally impossible to have a short enough path on Windows so you cannot use this project on Windows at all. |
|
This is already documented in https://docs.esp-rs.org/book/troubleshooting/index.html#long-path-names.
A lot of people use Windows for esp-rs projects, so its possible to workaround this issue. |
|
Shouldn't the Troubleshooting section be for issues that might occur? This issue is going to be hit by every Windows user (unless they're extremely lucky) so it makes sense to tell them about it up front rather than let them hit it and have to search for the solution. However, the check is actually not quite right so it probably makes sense to fix it before updating the documentation. See esp-rs/esp-idf-sys#293 |
This is not a problem for WSL users, which may windows users opt to use. So not all windows users are affected. Making a reference to it early on in the book would be a good idea though, would you mind updating your PR? |
|
Hi, sorry for the delay, I'm just coming back to this.
Might have forgotten the context but I think that's what this PR does already? |
This is a very surprising gotcha and kind of a pain to have to regenerate & recompile your project if you didn't know about it. Which you definitely didn't.