doc: reference: Add API Stability page
Add a page documenting the stability of Zephyr APIs. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
parent
4ffeb79ecd
commit
39930ca298
2 changed files with 256 additions and 0 deletions
|
@ -6,6 +6,7 @@ API Reference
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
stability.rst
|
||||
terminology.rst
|
||||
audio/index.rst
|
||||
bluetooth/index.rst
|
||||
|
|
255
doc/reference/stability.rst
Normal file
255
doc/reference/stability.rst
Normal file
|
@ -0,0 +1,255 @@
|
|||
.. _api_stability:
|
||||
|
||||
API Stability
|
||||
#############
|
||||
|
||||
The table below lists the available documented APIs in Zephyr, their
|
||||
:ref:`current status <api_lifecycle>` and the release that introduced them.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - API
|
||||
- Status
|
||||
- Version Introduced
|
||||
- Version Modified
|
||||
|
||||
* - :ref:`audio_codec_api`
|
||||
- Experimental
|
||||
- 1.13
|
||||
- 1.13
|
||||
|
||||
* - :ref:`audio_dmic_api`
|
||||
- Experimental
|
||||
- 1.13
|
||||
- 1.13
|
||||
|
||||
* - :ref:`bluetooth_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`can_api`
|
||||
- Experimental
|
||||
- 1.14
|
||||
- 2.1
|
||||
|
||||
* - :ref:`crypto_api`
|
||||
- Stable
|
||||
- 1.7
|
||||
- 2.2
|
||||
|
||||
* - :ref:`device_model_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`display_api`
|
||||
- Unstable
|
||||
- 1.14
|
||||
- 2.2
|
||||
|
||||
* - :ref:`file_system_api`
|
||||
- Stable
|
||||
- 1.5
|
||||
- 2.2
|
||||
|
||||
* - :ref:`kernel_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`logging_api`
|
||||
- Stable
|
||||
- 1.13
|
||||
- 1.14
|
||||
|
||||
* - :ref:`misc_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`networking_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`adc_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`clock_control_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`counter_api`
|
||||
- Unstable
|
||||
- 1.14
|
||||
- 2.2
|
||||
|
||||
* - :ref:`dma_api`
|
||||
- Stable
|
||||
- 1.5
|
||||
- 2.0
|
||||
|
||||
* - :ref:`eeprom_api`
|
||||
- Experimental
|
||||
- 2.1
|
||||
- 2.1
|
||||
|
||||
* - :ref:`entropy_api`
|
||||
- Stable
|
||||
- 1.10
|
||||
- 1.12
|
||||
|
||||
* - :ref:`flash_api`
|
||||
- Stable
|
||||
- 1.2
|
||||
- 1.10
|
||||
|
||||
* - :ref:`gna_api`
|
||||
- Experimental
|
||||
- 1.14
|
||||
- 1.14
|
||||
|
||||
* - :ref:`gpio_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`hwinfo_api`
|
||||
- Unstable
|
||||
- 1.14
|
||||
- 1.14
|
||||
|
||||
* - :ref:`i2c_eeprom_slave_api`
|
||||
- Stable
|
||||
- 1.13
|
||||
- 1.13
|
||||
|
||||
* - :ref:`i2c_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.1
|
||||
|
||||
* - :ref:`i2s_api`
|
||||
- Stable
|
||||
- 1.9
|
||||
- 1.12
|
||||
|
||||
* - :ref:`ipm_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 1.0
|
||||
|
||||
* - :ref:`led_api`
|
||||
- Stable
|
||||
- 1.12
|
||||
- 1.12
|
||||
|
||||
* - :ref:`kscan_api`
|
||||
- Stable
|
||||
- 2.1
|
||||
- 2.2
|
||||
|
||||
* - :ref:`pinmux_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 1.11
|
||||
|
||||
* - :ref:`ps2_api`
|
||||
- Stable
|
||||
- 2.1
|
||||
- 2.1
|
||||
|
||||
* - :ref:`pwm_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`sensor_api`
|
||||
- Stable
|
||||
- 1.2
|
||||
- 2.0
|
||||
|
||||
* - :ref:`spi_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 1.12
|
||||
|
||||
* - :ref:`uart_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.2
|
||||
|
||||
* - :ref:`UART async <uart_api>`
|
||||
- Unstable
|
||||
- 1.14
|
||||
- 2.2
|
||||
|
||||
* - :ref:`video_api`
|
||||
- Stable
|
||||
- 2.1
|
||||
- 2.1
|
||||
|
||||
* - :ref:`watchdog_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.0
|
||||
|
||||
* - :ref:`power_management_api`
|
||||
- Experimental
|
||||
- 1.2
|
||||
- 2.2
|
||||
|
||||
* - :ref:`random_api`
|
||||
- Stable
|
||||
- 1.0
|
||||
- 2.1
|
||||
|
||||
* - :ref:`settings_api`
|
||||
- Stable
|
||||
- 1.12
|
||||
- 2.1
|
||||
|
||||
* - :ref:`shell_api`
|
||||
- Stable
|
||||
- 1.14
|
||||
- 2.2
|
||||
|
||||
* - :ref:`disk_access_api`
|
||||
- Stable
|
||||
- 1.6
|
||||
- 2.0
|
||||
|
||||
* - :ref:`sdhc_api`
|
||||
- Stable
|
||||
- 1.14
|
||||
- 2.0
|
||||
|
||||
* - :ref:`fcb_api`
|
||||
- Stable
|
||||
- 1.11
|
||||
- 2.1
|
||||
|
||||
* - :ref:`flash_map_api`
|
||||
- Stable
|
||||
- 1.11
|
||||
- 2.0
|
||||
|
||||
* - :ref:`nvs_api`
|
||||
- Stable
|
||||
- 1.12
|
||||
- 1.14
|
||||
|
||||
* - :ref:`usb_api`
|
||||
- Stable
|
||||
- 1.5
|
||||
- 2.2
|
||||
|
||||
* - :ref:`usermode_api`
|
||||
- Stable
|
||||
- 1.11
|
||||
- 1.11
|
Loading…
Add table
Add a link
Reference in a new issue