First stab at API life cycle #1316
Conversation
docs/program-setup/build_rules.md
Outdated
| } | ||
|
|
||
| ``` | ||
| <!--so for a specific one, or does this now allow me to use all experimental APIs in one giant go?--> |
There was a problem hiding this comment.
I think it's worth having each set of experimental APIs having its own feature switch as well. So, for example, in order to use PSA, you would need to add both the EXPERIMENTAL_API and PSA features toggles.
There was a problem hiding this comment.
I think that's a decision for @bulislaw
There was a problem hiding this comment.
We discussed this ages ago, if I remember correctly, the consensus was behind "case by case". That is if the feature would have it's own flag it should be there hidden behind the master experimantal flag, so that when the API is stabilised no changes to the application are needed.
|
@bulislaw please can you either review or nominate someone else? |
docs/introduction/release_process.md
Outdated
|
|
||
| 1. Experimental: No changes are considered breaking, so they can be changed in any release type. They are on the Mbed OS Master branch and can be included in any Mbed OS build, but are identified as experimental and users have to explicitly include them. | ||
| 1. Stable: Can only be changed in a non-breaking manner. These are included by default in the Mbed OS full profile and, where appropriate, the bare metal profile. | ||
| 1. Deprecated: API deprecation is a breaking change, and done only in major releases. |
There was a problem hiding this comment.
I think this is a common misconcaption:
- Deprecated - marked to removal, but still available to the users (will generate a warning)
- Removal - deprecated API removed from the code base, not longer available to the user.
So when the API is deprecated it will be available to the users until next major release when it will be removed. The marking as "deprecated" can happen in minor relase.
There was a problem hiding this comment.
So do we have four phases, or a clarification for the three?
There was a problem hiding this comment.
I think 3 phases: Experimental, Stable, Deprecated; after the last one the API is removed in next major release. Deprecated should say that API is marked by deletion and its usage will generate a warning, it'll be removed in next major release. Marking API as deprecated is not a breaking change as the code using this API will continue to work until the next major release.
|
Handles manually because of merge conflicts. |
Based on source material I got in https://jira.arm.com/browse/IOTCLOUDPR-4231 and https://jira.arm.com/browse/IOTCLOUDPR-3928
Preview (VPN only):