Lines Matching full:api
3 API Lifecycle
7 given API will not change in future releases. At the same time, developers
15 :alt: API Life Cycle
18 API Life Cycle
32 - Documentation of the API (usage)
35 - The API introduction should be accompanied by at least one implementation
36 of said API (in the case of peripheral APIs, this corresponds to one driver)
37 - At least one sample using the new API (may only build on one single board)
42 When introducing an API (public header file with documentation) for a new
43 peripheral or driver subsystem, review of the API is enforced and is driven by
46 The API shall be promoted to ``unstable`` when it has at least two
52 The API is in the process of settling, but has not yet had sufficient real-world
53 testing to be considered stable. The API is considered generic in nature and can
63 The API shall be promoted from ``experimental`` to ``unstable`` when it has at
70 promote an API from ``experimental`` to ``unstable``.
75 The API has proven satisfactory, but cleanup in the underlying code may cause
78 An API can be declared ``stable`` after fulfilling the following requirements:
80 - Test cases for the new API with 100% coverage
83 - The API has been in-use and was available in at least 2 development releases
87 In order to declare an API ``stable``, the following steps need to be followed:
91 #. An email must be sent to the ``devel`` mailing list announcing the API
99 Introducing breaking API changes
102 A stable API, as described above, strives to remain backwards-compatible through
105 maintenance of the API and its implementation(s).
107 A breaking API change is defined as one that forces users to modify their
110 itself) is not considered a breaking API change.
121 Title: RFC: Breaking API Change: <subsystem>
125 - Brief description of the API change
131 - Impact to users of the API, including the steps required
132 to adapt out-of-tree users of the API to the change
136 #. The RFC issue must be labeled with the GitHub ``Breaking API Change`` label
155 - The actual changes to the API
157 - Changes to the API header file
158 - Changes to the API implementation(s)
159 - Changes to the relevant API documentation
162 - The changes required to adapt in-tree users of the API to the change.
165 - An entry in the "API Changes" section of the release notes for the next
167 - The labels ``API``, ``Breaking API Change`` and ``Release Notes``, as well as
180 Breaking API changes will be listed and described in the migration guide.
188 Deprecation and removal of APIs will be announced in the "API Changes"
191 The following are the requirements for deprecating an existing API:
194 The API needs to be marked as deprecated in at least two full releases.
195 For example, if an API was first deprecated in release 1.14,
198 where an API is deprecated sooner.
207 - Include the deprecation in the "API Changes" of the release notes for the
209 - Code using the deprecated API needs to be modified to remove usage of said
210 API
212 - Create a GitHub issue to track the removal of the deprecated API, and
216 During the deprecation waiting period, the API will be in the ``deprecated``
221 - API documentation will inform users that the API is deprecated.
222 - Attempts to use a deprecated API at build time will log a warning to the
229 In this phase, the API is removed.
232 The Zephyr maintainers will decide when to actually remove the API: this
234 deprecated API, and on how urgently the API needs to be removed.
236 If it's OK to remove the API, it will be removed. The maintainers will remove
240 If it's not OK to remove the API, the maintainers will continue to support
241 migration and update the roadmap with the aim to remove the API in the next