doc: initial migration guides

This commit is contained in:
morris 2021-10-25 17:32:13 +08:00
parent 16677b0d3c
commit 2a948cd09b
6 changed files with 28 additions and 0 deletions

View File

@ -62,6 +62,7 @@ This is the documentation for Espressif IoT Development Framework (`esp-idf <htt
API Reference <api-reference/index>
H/W Reference <hw-reference/index>
API Guides <api-guides/index>
ESP-IDF 5.0 Migration Guides <migration-guides/index>
Libraries and Frameworks <libraries-and-frameworks/index>
Contribute <contribute/index>
Versions <versions>

View File

@ -0,0 +1,8 @@
ESP-IDF 5.0 Migration Guides
****************************
:link_to_translation:`zh_CN:[中文]`
.. toctree::
:maxdepth: 1
Peripherals <peripherals>

View File

@ -0,0 +1,9 @@
Migrate Peripherals to ESP-IDF 5.0
==================================
Peripheral Clock Gating
-----------------------
As usual, peripheral clock gating is still handled by driver itself, users don't need to take care of the peripheral module clock gating.
However, for advanced users who implement their own drivers based on ``hal`` and ``soc`` components, the previous clock gating include path has been changed from ``driver/periph_ctrl.h`` to ``esp_private/periph_ctrl.h``.

View File

@ -62,6 +62,7 @@ ESP-IDF 编程指南
API 参考 <api-reference/index>
H/W 参考 <hw-reference/index>
API 指南 <api-guides/index>
ESP-IDF 5.0 迁移指南 <migration-guides/index>
Libraries and Frameworks <libraries-and-frameworks/index>
贡献代码 <contribute/index>
版本 <versions>

View File

@ -0,0 +1,8 @@
ESP-IDF 5.0 迁移指南
********************
:link_to_translation:`zh_CN:[中文]`
.. toctree::
:maxdepth: 1
外设 <peripherals>

View File

@ -0,0 +1 @@
.. include:: ../../en/migration-guides/peripherals.rst