Commit Graph

5 Commits

Author SHA1 Message Date
Gerard Marull-Paretas
9dfbdf1997 doc: use kconfig role and directive
Stop using :option: for Kconfig options.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-06-29 10:26:28 -04:00
Martí Bolívar
2b2f2c94a7 api: devicetree.h is stable
This API meets the requirements for marking an API stable:

- Test cases for the new API with 100% coverage: yes;
  we have had coverage for every API macro since the beginning.

- Complete documentation in code. All public interfaces shall be
  documented and available in online documentation.: yes, in the
  reference documentation:
  https://docs.zephyrproject.org/latest/reference/devicetree/api.html

- The API has been in-use and was available in at least 2 development
  releases: yes; this API ws introduced in v2.3.

The basic design involving node identifiers and the macros that create
and operate on them has not changed since the API was introduced, and
it is in widespread use throughout the tree. As we head into a new
LTS, it's time to mark it stable.

This is more of an acknowledgement of reality than a big change, as I
don't see any backwards incompatible changes since the API was first
introduced in v2.3. (We have deprecated a lot of label related macros
that are no longer required now that we have DEVICE_DT_GET and
friends, but they're still there, and we're still testing them, just
as if this were a stable API.)

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-06-14 15:18:11 +02:00
Martí Bolívar
73443088ba doc: api: fix devicetree modification version
This was modified in 2.6.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-06-11 17:59:35 -04:00
Kumar Gala
36a24329f8 doc/ref/api: Update API Version Modified
Update API Version Modified field for things that changed
for the 2.6.0 release.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-04 15:04:53 -05:00
Anas Nashif
077447a52b doc: consolidate api status and guidelines
Move all docs related to APIs and the guidelines around them into one
page.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-04-20 14:38:16 +02:00