platformio / platformio-docs

PlatformIO Documentation
https://docs.platformio.org
Apache License 2.0
240 stars 325 forks source link

Document how to use custom mbed-os version in platformio #214

Open douardda opened 2 years ago

CLAassistant commented 2 years ago

CLA assistant check
All committers have signed the CLA.

maxgerhardt commented 2 years ago

The general problem with telling people how to use custom versions is that they then think

  1. Using custom mbed-os versions like that is officially supported by PlatformIO staff (there's a "no beta software supported" policy, and one can think of "beta" as "outside of official PlatformIO repositories" here)
  2. That it will always work without problems, when e.g. for 6.15.0 it does not because as outlined of a Python dependency missing out-of-the box. People would then have to have a slightly deeper PlatformIO knowledge to understand where the Python / pip installation that PlatformIO is using is and fixup that. And if the builder script starts to fail for newer mbed-os versions because they changed their build API, it's going to be even more complicated for non-staff to fix it. The documentation does not mention all these caveats.

This is definitely useful information for many people, but having it in official docs would give a false sense of "this always works, just do that".

douardda commented 2 years ago

Thanks a lot @maxgerhardt I'll try to address your comments ASAP.

douardda commented 2 years ago

The general problem with telling people how to use custom versions is that they then think

1. Using custom mbed-os versions like that is officially supported by PlatformIO staff (there's a "no beta software supported" policy, and one can think of "beta" as "outside of official PlatformIO repositories" here)

2. That it will always work without problems, when e.g. for 6.15.0 it does not because [as outlined](https://community.platformio.org/t/support-for-mbed-os-6-stable-and-mature-apis-cloud-services-support-enhancements-to-the-bare-metal-profile/15079/10?u=maxgerhardt) of a Python dependency missing out-of-the box. People would then have to have a slightly deeper PlatformIO knowledge to understand where the Python / pip installation that PlatformIO is using is and fixup that. And if the builder script starts to fail for newer mbed-os versions because they changed their build API, it's going to be even more complicated for non-staff to fix it. The documentation does not mention all these caveats.

This is definitely useful information for many people, but having it in official docs would give a false sense of "this always works, just do that".

I agree and propose to include a big disclamer in this section.

douardda commented 2 years ago

I've updated a bit the PR, hopefully addressing all your comments.

Thanks again.

mmontag commented 2 years ago

Bump...merge this?