docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit

2024-01-19 14:40:33 +08:00
parent 9ba5f4dab2
commit 22a053f1fc
195 changed files with 2385 additions and 2393 deletions
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/bt_common.rst
+.. include:: ../../../en/api-reference/bluetooth/bt_common.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/bt_le.rst
+.. include:: ../../../en/api-reference/bluetooth/bt_le.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/classic_bt.rst
+.. include:: ../../../en/api-reference/bluetooth/classic_bt.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/controller_vhci.rst
+.. include:: ../../../en/api-reference/bluetooth/controller_vhci.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp-ble-mesh.rst
+.. include:: ../../../en/api-reference/bluetooth/esp-ble-mesh.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_a2dp.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_a2dp.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_avrc.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_avrc.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_blufi.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_blufi.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_bt_defs.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_bt_defs.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_bt_device.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_bt_device.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_bt_main.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_bt_main.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_gap_bt.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_gap_bt.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_gatt_defs.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_gatt_defs.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_gattc.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_gattc.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_l2cap_bt.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_l2cap_bt.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_sdp.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_sdp.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/bluetooth/esp_spp.rst
+.. include:: ../../../en/api-reference/bluetooth/esp_spp.rst
@@ -16,4 +16,4 @@ API 参考
   kconfig
   provisioning/index
   storage/index
-   system/index
+   system/index
@@ -104,7 +104,7 @@ ESP-WIFI-MESH 在正常启动前必须先初始化 LwIP 和 Wi-Fi 软件栈。

 .. _mesh-initialize-mesh:

-初始化 Mesh 
+初始化 Mesh
 ^^^^^^^^^^^^^^^

 下方代码片段展示如何初始化 ESP-WIFI-MESH。
@@ -126,28 +126,28 @@ ESP-WIFI-MESH 在正常启动前必须先初始化 LwIP 和 Wi-Fi 软件栈。
 ESP-WIFI-MESH 可通过 :cpp:func:`esp_mesh_set_config` 进行配置，并使用 :cpp:type:`mesh_cfg_t` 结构体传递参数。该结构体包含以下 ESP-WIFI-MESH 的配置参数：


-.. list-table::         
-   :header-rows: 1          
-   :widths: 15 25           
-            
+.. list-table::
+   :header-rows: 1
+   :widths: 15 25
+
   * - 参数
     - 描述
-          
+
   * - Channel（信道）
     - 1 到 14 信道
-          
+
   * - Mesh ID
-     - ESP-WIFI-MESH 网络的 ID，见 :cpp:type:`mesh_addr_t`。 
-          
+     - ESP-WIFI-MESH 网络的 ID，见 :cpp:type:`mesh_addr_t`。
+
   * - Router（路由器）
-     - 路由器配置，见 :cpp:type:`mesh_router_t`。  
-          
+     - 路由器配置，见 :cpp:type:`mesh_router_t`。
+
   * - Mesh AP
-     - Mesh AP 配置，见 :cpp:type:`mesh_ap_cfg_t` 
+     - Mesh AP 配置，见 :cpp:type:`mesh_ap_cfg_t`

   * - Crypto Functions（加密函数）
-     - Mesh IE 的加密函数，见 :cpp:type:`mesh_crypto_funcs_t`。 
-          
+     - Mesh IE 的加密函数，见 :cpp:type:`mesh_crypto_funcs_t`。
+

 下方代码片段展示如何配置 ESP-WIFI-MESH。

@@ -26,4 +26,4 @@ Easy Connect 协议仍在不断发展。目前已知支持二维码的平台为
 API 参考
 -------------

-.. include-build-file:: inc/esp_dpp.inc
+.. include-build-file:: inc/esp_dpp.inc
@@ -17,4 +17,4 @@ Wi-Fi Aware\ :sup:`TM`，也可称为 NAN (Neighbor Awareness Networking) 协议
 API 参考
 -------------

-.. include-build-file:: inc/esp_nan.inc
+.. include-build-file:: inc/esp_nan.inc
@@ -19,4 +19,4 @@ SmartConfig\ :sup:`TM` 是由 TI 开发的配网技术，用于将新的 Wi-Fi
 API 参考
 ----------

-.. include-build-file:: inc/esp_smartconfig.inc
+.. include-build-file:: inc/esp_smartconfig.inc
@@ -64,28 +64,28 @@ GPIO 驱动提供了一个函数 :cpp:func:`gpio_dump_io_configuration` 用来
    GPIO 毛刺过滤器
    ---------------

-	{IDF_TARGET_NAME} 内置硬件的过滤器可以过滤掉 GPIO 输入端口上的毛刺信号，在一定程度上避免错误触发中断或者是错把噪声当成有效的外设信号。
+    {IDF_TARGET_NAME} 内置硬件的过滤器可以过滤掉 GPIO 输入端口上的毛刺信号，在一定程度上避免错误触发中断或者是错把噪声当成有效的外设信号。

-	.. only:: SOC_GPIO_SUPPORT_PIN_GLITCH_FILTER
+    .. only:: SOC_GPIO_SUPPORT_PIN_GLITCH_FILTER

-		每个 GPIO 都可以使用独立的毛刺过滤器，该过滤器可以将那些脉冲宽度窄于 **2** 个采样时钟的信号剔除掉，该宽度无法配置。GPIO 对输入信号的采样时钟通常是 IO_MUX 的时钟源。在驱动中，此类过滤器称为 ``管脚毛刺过滤器``。可以调用 :cpp:func:`gpio_new_pin_glitch_filter` 函数创建一个过滤器句柄。过滤器的相关配置保存在 :cpp:type:`gpio_pin_glitch_filter_config_t` 结构体中。
+        每个 GPIO 都可以使用独立的毛刺过滤器，该过滤器可以将那些脉冲宽度窄于 **2** 个采样时钟的信号剔除掉，该宽度无法配置。GPIO 对输入信号的采样时钟通常是 IO_MUX 的时钟源。在驱动中，此类过滤器称为 ``管脚毛刺过滤器``。可以调用 :cpp:func:`gpio_new_pin_glitch_filter` 函数创建一个过滤器句柄。过滤器的相关配置保存在 :cpp:type:`gpio_pin_glitch_filter_config_t` 结构体中。

-		- :cpp:member:`gpio_pin_glitch_filter_config_t::gpio_num` 设置启用毛刺过滤器的 GPIO 编号。
+        - :cpp:member:`gpio_pin_glitch_filter_config_t::gpio_num` 设置启用毛刺过滤器的 GPIO 编号。

-	.. only:: SOC_GPIO_FLEX_GLITCH_FILTER_NUM
+    .. only:: SOC_GPIO_FLEX_GLITCH_FILTER_NUM

-		{IDF_TARGET_FLEX_GLITCH_FILTER_NUM:default="8"}
+        {IDF_TARGET_FLEX_GLITCH_FILTER_NUM:default="8"}

-		{IDF_TARGET_NAME} 提供了 {IDF_TARGET_FLEX_GLITCH_FILTER_NUM} 个灵活的毛刺过滤器，被过滤信号的脉冲宽度可以由软件进行配置。此类过滤器则称为 ``灵活毛刺过滤器``。每个过滤器都可以应用于任意 GPIO 输入，然而，将多个过滤器应用于同一 GPIO 上效果并不会叠加。可以调用 :cpp:func:`gpio_new_flex_glitch_filter` 函数来创建一个过滤器句柄。过滤器的相关配置保存在 :cpp:type:`gpio_flex_glitch_filter_config_t` 结构体中。
+        {IDF_TARGET_NAME} 提供了 {IDF_TARGET_FLEX_GLITCH_FILTER_NUM} 个灵活的毛刺过滤器，被过滤信号的脉冲宽度可以由软件进行配置。此类过滤器则称为 ``灵活毛刺过滤器``。每个过滤器都可以应用于任意 GPIO 输入，然而，将多个过滤器应用于同一 GPIO 上效果并不会叠加。可以调用 :cpp:func:`gpio_new_flex_glitch_filter` 函数来创建一个过滤器句柄。过滤器的相关配置保存在 :cpp:type:`gpio_flex_glitch_filter_config_t` 结构体中。

-		- :cpp:member:`gpio_flex_glitch_filter_config_t::gpio_num` 设置启用毛刺过滤器的 GPIO 编号。
-		- :cpp:member:`gpio_flex_glitch_filter_config_t::window_width_ns` 和 :cpp:member:`gpio_flex_glitch_filter_config_t::window_thres_ns` 是毛刺过滤器的关键参数。在:cpp:member:`gpio_flex_glitch_filter_config_t::window_width_ns` 时间内，任何脉冲信号，如果它的宽度小于 :cpp:member:`gpio_flex_glitch_filter_config_t::window_thres_ns` ，那么该脉冲信号就会被滤除掉。:cpp:member:`gpio_flex_glitch_filter_config_t::window_thres_ns` 的值不能大于 :cpp:member:`gpio_flex_glitch_filter_config_t::window_width_ns`。
+        - :cpp:member:`gpio_flex_glitch_filter_config_t::gpio_num` 设置启用毛刺过滤器的 GPIO 编号。
+        - :cpp:member:`gpio_flex_glitch_filter_config_t::window_width_ns` 和 :cpp:member:`gpio_flex_glitch_filter_config_t::window_thres_ns` 是毛刺过滤器的关键参数。在:cpp:member:`gpio_flex_glitch_filter_config_t::window_width_ns` 时间内，任何脉冲信号，如果它的宽度小于 :cpp:member:`gpio_flex_glitch_filter_config_t::window_thres_ns` ，那么该脉冲信号就会被滤除掉。:cpp:member:`gpio_flex_glitch_filter_config_t::window_thres_ns` 的值不能大于 :cpp:member:`gpio_flex_glitch_filter_config_t::window_width_ns`。

-	.. only:: SOC_GPIO_SUPPORT_PIN_GLITCH_FILTER and SOC_GPIO_FLEX_GLITCH_FILTER_NUM
+    .. only:: SOC_GPIO_SUPPORT_PIN_GLITCH_FILTER and SOC_GPIO_FLEX_GLITCH_FILTER_NUM

-		请注意，``管脚毛刺过滤器`` 和 ``灵活毛刺过滤器`` 是各自独立的，支持为同一 GPIO 同时启用这两种过滤器。
+        请注意，``管脚毛刺过滤器`` 和 ``灵活毛刺过滤器`` 是各自独立的，支持为同一 GPIO 同时启用这两种过滤器。

-	毛刺过滤器默认关闭，可调用 :cpp:func:`gpio_glitch_filter_enable` 使能过滤器。如需回收这个过滤器，可以调用 :cpp:func:`gpio_del_glitch_filter` 函数。在回收句柄前，请确保过滤器处于关闭状态，否则需调用 :cpp:func:`gpio_glitch_filter_disable`。
+    毛刺过滤器默认关闭，可调用 :cpp:func:`gpio_glitch_filter_enable` 使能过滤器。如需回收这个过滤器，可以调用 :cpp:func:`gpio_del_glitch_filter` 函数。在回收句柄前，请确保过滤器处于关闭状态，否则需调用 :cpp:func:`gpio_glitch_filter_disable`。


 .. only:: SOC_GPIO_SUPPORT_PIN_HYS_FILTER
@@ -358,4 +358,4 @@ API 参考
   在不同的 ESP 芯片系列中，PCNT 单元和通道的数量可能会有差异，具体信息请参考 [`TRM <{IDF_TARGET_TRM_CN_URL}#pcnt>`__]。驱动程序对通道申请数量不做限制，但当硬件资源用尽时，驱动程序将返回错误。因此分配资源时，应注意检查返回值，如 :cpp:func:`pcnt_new_unit`。

 .. [2]
-   :cpp:member:`pcnt_event_callbacks_t::on_reach` 回调函数和其调用的函数也应该放在 IRAM 中。
+   :cpp:member:`pcnt_event_callbacks_t::on_reach` 回调函数和其调用的函数也应该放在 IRAM 中。
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/peripherals/sd_pullup_requirements.rst
+.. include:: ../../../en/api-reference/peripherals/sd_pullup_requirements.rst
@@ -84,4 +84,4 @@ IRAM 安全中断处理程序

 .. only:: SOC_SPIRAM_XIP_SUPPORTED

-   .. include:: xip_from_psram.inc
+   .. include:: xip_from_psram.inc
@@ -72,7 +72,7 @@ SPI 传输事务
 使用驱动程序
 ------------

- 调用函数 cpp:func:`spi_slave_initialize`，将 SPI 外设初始化为从机设备。请确保在 `bus_config` 中设置正确的 I/O 管脚，并将未使用的信号设置为 ``-1``。
+- 调用函数  :cpp:func:`spi_slave_initialize`，将 SPI 外设初始化为从机设备。请确保在 `bus_config` 中设置正确的 I/O 管脚，并将未使用的信号设置为 ``-1``。

 .. only:: esp32

@@ -131,4 +131,4 @@ SPI 从机半双工模式
 API 参考
 -------------

-.. include-build-file:: inc/spi_slave_hd.inc
+.. include-build-file:: inc/spi_slave_hd.inc
@@ -18,7 +18,7 @@

 .. only:: esp32

-	如果想评估触摸传感器的多种应用场景，请查看 `ESP32 触摸功能开发套件 <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32/esp32-sense-kit/user_guide.html>`_。
+  如果想评估触摸传感器的多种应用场景，请查看 `ESP32 触摸功能开发套件 <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32/esp32-sense-kit/user_guide.html>`_。

 功能介绍
 ----------------------
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/peripherals/twai.rst
+.. include:: ../../../en/api-reference/peripherals/twai.rst
@@ -1,2 +1,2 @@
 .. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_arch
-    .rst
+    .rst
@@ -1 +1 @@
-.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_design.rst
+.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_design.rst
@@ -1 +1 @@
-.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_dwc_otg.rst
+.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_dwc_otg.rst
@@ -1 +1 @@
-.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_index.rst
+.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_index.rst
@@ -16,4 +16,4 @@ ASIO 是一个跨平台的 C++ 库，参见 https://think-async.com/Asio/。它

 访问以下链接查看相关文档：

-* `ASIO 文档 (English) <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`__
+* `ASIO 文档 (English) <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`__
@@ -20,7 +20,7 @@ API 说明
  * :cpp:func:`httpd_sess_set_send_override`
  * :cpp:func:`httpd_sess_set_recv_override`
  * :cpp:func:`httpd_sess_set_pending_override`
-  
+
 * "transport context"——传输层上下文

  * :cpp:func:`httpd_sess_get_transport_ctx`：返回会话使用的 SSL
@@ -117,4 +117,4 @@ ICMP echo 示例： :example:`protocols/icmp_echo`
 API 参考
 --------------

-.. include-build-file:: inc/ping_sock.inc
+.. include-build-file:: inc/ping_sock.inc
@@ -123,4 +123,4 @@ ESP-IDF 中的示例使用 :doc:`/api-reference/protocols/esp_tls`，为访问


 .. _`API Reference`: https://mbed-tls.readthedocs.io/projects/api/en/v3.4.1/
-.. _`Knowledge Base`: https://mbed-tls.readthedocs.io/en/latest/kb/
+.. _`Knowledge Base`: https://mbed-tls.readthedocs.io/en/latest/kb/
@@ -15,7 +15,7 @@ SPIFFS 是一个用于 SPI NOR flash 设备的嵌入式文件系统，支持磨
 - SPIFFS 并非实时栈，每次写操作耗时不等；
 - 目前，SPIFFS 尚不支持检测或处理已损坏的块。
 - SPIFFS 只能稳定地使用约 75% 的指定分区容量。
- - 当文件系统空间不足时，垃圾收集器会尝试多次扫描文件系统来寻找可用空间。根据所需空间的不同，写操作会被调用多次，每次函数调用将花费几秒。同一操作可能会花费不同时长的问题缘于 SPIFFS 的设计，且已在官方的 `SPIFFS github 仓库 <https://github.com/pellepl/spiffs/issues/>`_ 或是 <https://github.com/espressif/esp-idf/issues/1737>`_ 中被多次报告。这个问题可以通过 `SPIFFS 配置 <https://github.com/pellepl/spiffs/wiki/Configure-spiffs>`_ 部分缓解。
+ - 当文件系统空间不足时，垃圾收集器会尝试多次扫描文件系统来寻找可用空间。根据所需空间的不同，写操作会被调用多次，每次函数调用将花费几秒。同一操作可能会花费不同时长的问题缘于 SPIFFS 的设计，且已在官方的 `SPIFFS github 仓库 <https://github.com/pellepl/spiffs/issues/>`_ 或是 `<https://github.com/espressif/esp-idf/issues/1737>`_ 中被多次报告。这个问题可以通过 `SPIFFS 配置 <https://github.com/pellepl/spiffs/wiki/Configure-spiffs>`_ 部分缓解。
 - 被删除文件通常不会被完全清除，会在文件系统中遗留下无法使用的部分。
 - 如果 {IDF_TARGET_NAME} 在文件系统操作期间断电，可能会导致 SPIFFS 损坏。但是仍可通过 ``esp_spiffs_check`` 函数恢复文件系统。详情请参阅官方 SPIFFS `FAQ <https://github.com/pellepl/spiffs/wiki/FAQ>`_。

@@ -25,7 +25,7 @@ SPIFFS 是一个用于 SPI NOR flash 设备的嵌入式文件系统，支持磨
 ``spiffsgen.py``
 ^^^^^^^^^^^^^^^^

-:component_file:`spiffsgen.py<spiffs/spiffsgen.py>`（只写）是 SPIFFS 的一种 Python 实现，可用于从主机文件夹内容生成文件系统镜像。打开终端并运行以下命令即可使用 ``spiffsgen.py``::
+:component_file:`spiffsgen.py<spiffs/spiffsgen.py>` （只写）是 SPIFFS 的一种 Python 实现，可用于从主机文件夹内容生成文件系统镜像。打开终端并运行以下命令即可使用 ``spiffsgen.py``::

    python spiffsgen.py <image_size> <base_dir> <output_file>

@@ -18,4 +18,4 @@ API 参考
 -------------

 .. include-build-file:: inc/esp_app_trace.inc
-.. include-build-file:: inc/esp_sysview_trace.inc
+.. include-build-file:: inc/esp_sysview_trace.inc
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/efuse.rst
+.. include:: ../../../en/api-reference/system/efuse.rst
@@ -15,7 +15,7 @@
 .. only:: SOC_BT_SUPPORTED

    .. note::
-    
+
        蓝牙栈各模块通过调用专用回调函数向应用程序传递事件，而非通过事件循环库传递。

 调用 ``esp_event`` API
@@ -134,7 +134,7 @@
      - :cpp:func:`esp_event_loop_create_default`
    * - :cpp:func:`esp_event_loop_delete`
      - :cpp:func:`esp_event_loop_delete_default`
-    * - :cpp:func:`esp_event_handler_register_with` 
+    * - :cpp:func:`esp_event_handler_register_with`
      - :cpp:func:`esp_event_handler_register`
    * - :cpp:func:`esp_event_handler_unregister_with`
      - :cpp:func:`esp_event_handler_unregister`
@@ -81,9 +81,9 @@ Vanilla FreeRTOS 提供以下用于创建任务的函数：

 不同于普通的任务创建函数 API，``...PinnedToCore()`` 版本的任务创建函数 API 有额外的 ``xCoreID`` 参数，用于指定所创建任务的核亲和性。核亲和性的有效值包括：

-	``0``：将创建的任务分配给核 0
-	``1``：将创建的任务分配给核 1
-	``tskNO_AFFINITY``：支持任务在两个核上运行
+- ``0``：将创建的任务分配给核 0
+- ``1``：将创建的任务分配给核 1
+- ``tskNO_AFFINITY``：支持任务在两个核上运行

 注意，IDF FreeRTOS 仍支持普通的任务创建函数，但这些标准函数已经过调整，会内部调用其 ``...PinnedToCore()`` 版本，同时将核亲和性设置为 ``tskNO_AFFINITY``。

@@ -26,4 +26,4 @@ ESP-IDF 中提供了对大内存范围进行简单内存测试的示例，请前
 API 参考
 -------------

-.. include-build-file:: inc/himem.inc
+.. include-build-file:: inc/himem.inc
@@ -1,2 +1 @@
 .. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C2.rst
-    
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C3.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C3.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-H2.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-H2.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-P4.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-P4.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S2.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S2.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S3.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S3.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32.rst
@@ -28,4 +28,4 @@
 +               +---------------------------------------+-------------------------------------+
 |               |                  无                   | 使用 :cpp:func:`esp_pm_configure`   |
 |               |                                       | 为二者设置最小值                    |
-+---------------+---------------------------------------+-------------------------------------+
+---------------+---------------------------------------+-------------------------------------+
@@ -1 +1 @@
-TO BE UPDATED IDF-7672
+TO BE UPDATED IDF-7672
@@ -55,7 +55,7 @@

 .. note::

-    在关键部分中断被禁用，因此只能使用 ``ESP_DRAM_LOGx``（首选）或 ``ESP_EARLY_LOGx`` 宏。尽管这样可以输出日志，但最好可以调整程序使其不用输出日志。
+    在关键部分中断被禁用，因此只能使用 ``ESP_DRAM_LOGx`` （首选）或 ``ESP_EARLY_LOGx`` 宏。尽管这样可以输出日志，但最好可以调整程序使其不用输出日志。

 如需在文件或组件范围内覆盖默认的日志级别，请定义 ``LOG_LOCAL_LEVEL`` 宏。

@@ -56,7 +56,7 @@ OTA 数据分区的容量是 2 个 flash 扇区的大小（0x2000 字节），
                               则仅会选取一次。在引导加载程序中，状态立即变为
                               ``ESP_OTA_IMG_PENDING_VERIFY``。
 ESP_OTA_IMG_PENDING_VERIFY    如使能 :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE`，
-                               则不会选取，状态变为``ESP_OTA_IMG_ABORTED``。
+                               则不会选取，状态变为 ``ESP_OTA_IMG_ABORTED``。
 =============================  ========================================================

 如果 :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` 没有使能（默认情况），则 :cpp:func:`esp_ota_mark_app_valid_cancel_rollback` 和 :cpp:func:`esp_ota_mark_app_invalid_rollback_and_reboot` 为可选功能，``ESP_OTA_IMG_NEW`` 和 ``ESP_OTA_IMG_PENDING_VERIFY`` 不会使用。
@@ -153,9 +153,9 @@ Kconfig 中的 :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` 可以帮助用户
                if (data_read > sizeof(esp_image_header_t) + sizeof(esp_image_segment_header_t) + sizeof(esp_app_desc_t)) {
                    // check current version with downloading
                    if (esp_efuse_check_secure_version(new_app_info.secure_version) == false) {
-                    	ESP_LOGE(TAG, "This a new app can not be downloaded due to a secure version is lower than stored in efuse.");
-                    	http_cleanup(client);
-                    	task_fatal_error();
+                      ESP_LOGE(TAG, "This a new app can not be downloaded due to a secure version is lower than stored in efuse.");
+                      http_cleanup(client);
+                      task_fatal_error();
                    }

                    image_header_was_checked = true;
@@ -322,4 +322,3 @@ OTA 升级失败排查
    :figclass: align-center

    OTA 升级失败时如何排查（点击放大）
-
@@ -401,7 +401,7 @@ flash 断电

    在函数 :cpp:func:`esp_deep_sleep_start` 前增加以下代码即可避免额外电流消耗::

-	rtc_gpio_isolate(GPIO_NUM_12);
+        rtc_gpio_isolate(GPIO_NUM_12);

 .. only:: esp32c2 or esp32c3

@@ -102,4 +102,4 @@ API 参考

    8. 在任何情况下，要生成 API 参考文档，应该更新文件 :idf_file:`docs/doxygen/Doxyfile` 并将其中的路径更新为正在添加文档的 ``*.h`` 头文件的路径。

-    9. 更改提交并构建文档后，可以查看文档的渲染效果。如有需要，为相应的头文件 :doc:`纠正注释 <../contribute/documenting-code>`。
+    9. 更改提交并构建文档后，可以查看文档的渲染效果。如有需要，为相应的头文件 :doc:`纠正注释 <../contribute/documenting-code>`。
				`@@ -1,2 +1 @@`
				`.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C2.rst`