Breaking changes to ESP-IDF BLE support and version management

[kolban]

Howdy Folks,
I seem to find that there have been dramatic changes to the BLE APIs found in the ESP-IDF BLE support. See this commit log for details:

https://github.com/espressif/esp-idf/co ... aeeca7863a

The implication of this is that the applications written to the ESP-IDF v2.1 (or below) will no longer compile and work against the lasted ESP-IDF master.

Philosophically, I understand this. If we are adopting semantic versioning then when we go from v2.1 to v3.0 then we should expect to have re-work as the rules say that a major revision need no longer be API compliant.

In my ideal world, I would have liked:

1) As much notice as possible of APIs that are likely to change from v2.1 to v3.0 to accommodate in design.
2) Deprecation of older APIs rather than instant removal.

I'm also concerned that the current documentation found here:

http://esp-idf.readthedocs.io/en/latest ... gattc.html

Seems to reflect the pre-release 3.0 ESP-IDF as opposed to the current release (2.1). If I'm understanding correctly, then if I downloaded v2.1 (the current release) and tried to build BLE apps using the current docs (link above) I would fail because the docs are for Git master rather than v2.1 release.

[WiFive]

Does this help: http://esp-idf.readthedocs.io/en/v2.1/

[kolban]

Thank you sir ... that DOES help tremendously. In fact that is perfect. I think I am now seeing that the available documentation is generated based on the releases. So there is a set of documentation for each release and a set of documentation (latest) available for the Git master source. This is indeed extremely useful. Thank you kind sir.