forked from espressif/esp-idf
docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit
This commit is contained in:
@@ -322,4 +322,3 @@ Debugging OTA Failure
|
|||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
|
|
||||||
How to Debug When OTA Fails (click to enlarge)
|
How to Debug When OTA Fails (click to enlarge)
|
||||||
|
|
||||||
|
@@ -6,7 +6,7 @@ Peripherals
|
|||||||
Drivers
|
Drivers
|
||||||
-------
|
-------
|
||||||
|
|
||||||
In order to control the dependence of other components on drivers at a smaller granularity, the original peripheral drivers under the `driver`` component were split into separate components:
|
In order to control the dependence of other components on drivers at a smaller granularity, the original peripheral drivers under the ``driver`` component were split into separate components:
|
||||||
|
|
||||||
- `esp_driver_gptimer` - Driver for general purpose timers
|
- `esp_driver_gptimer` - Driver for general purpose timers
|
||||||
- `esp_driver_pcnt` - Driver for pulse counter
|
- `esp_driver_pcnt` - Driver for pulse counter
|
||||||
@@ -28,7 +28,7 @@ In order to control the dependence of other components on drivers at a smaller g
|
|||||||
- `esp_driver_parlio` - Driver for Parallel IO
|
- `esp_driver_parlio` - Driver for Parallel IO
|
||||||
- `esp_driver_usb_serial_jtag` - Driver for USB_SERIAL_JTAG
|
- `esp_driver_usb_serial_jtag` - Driver for USB_SERIAL_JTAG
|
||||||
|
|
||||||
For compatibility, the original `driver`` component is still treated as an all-in-one component by registering these `esp_driver_xyz`` components as its public dependencies. In other words, you do not need to modify the CMake file of an existing project, but you now have a way to specify the specific peripheral driver that your project depends on.
|
For compatibility, the original ``driver`` component is still treated as an all-in-one component by registering these `esp_driver_xyz` components as its public dependencies. In other words, you do not need to modify the CMake file of an existing project, but you now have a way to specify the specific peripheral driver that your project depends on.
|
||||||
|
|
||||||
Originally, you may have used **linker.lf** to specify the link location of some driver functions in memory space, but now, because the location of the driver files have been moved, you need to make changes your **linker.lf** file accordingly. For example, a linker.lf file with the following entries:
|
Originally, you may have used **linker.lf** to specify the link location of some driver functions in memory space, but now, because the location of the driver files have been moved, you need to make changes your **linker.lf** file accordingly. For example, a linker.lf file with the following entries:
|
||||||
|
|
||||||
|
@@ -607,5 +607,3 @@ Secure Boot V2 Guidelines
|
|||||||
.. only:: SOC_EFUSE_REVOKE_BOOT_KEY_DIGESTS
|
.. only:: SOC_EFUSE_REVOKE_BOOT_KEY_DIGESTS
|
||||||
|
|
||||||
* It is recommended to use all the available digest slots to reduce dependency on a single private key.
|
* It is recommended to use all the available digest slots to reduce dependency on a single private key.
|
||||||
|
|
||||||
|
|
||||||
|
@@ -1311,7 +1311,7 @@ ESP-IDF 构建属性
|
|||||||
- DEPENDENCIES_LOCK - 组件管理器使用的依赖关系锁定文件的路径。默认值为项目路径下的 `dependencies.lock`。
|
- DEPENDENCIES_LOCK - 组件管理器使用的依赖关系锁定文件的路径。默认值为项目路径下的 `dependencies.lock`。
|
||||||
- EXECUTABLE_NAME - 不含扩展名的项目可执行文件的名称;通过调用 ``idf_build_executable`` 设置。
|
- EXECUTABLE_NAME - 不含扩展名的项目可执行文件的名称;通过调用 ``idf_build_executable`` 设置。
|
||||||
- EXECUTABLE_DIR - 输出的可执行文件的路径
|
- EXECUTABLE_DIR - 输出的可执行文件的路径
|
||||||
- IDF_COMPONENT_MANAGER - 默认启用组件管理器,但如果设置这个属性为`0``,则会被 IDF_COMPONENT_MANAGER 环境变量禁用。
|
- IDF_COMPONENT_MANAGER - 默认启用组件管理器,但如果设置这个属性为 ``0``,则会被 IDF_COMPONENT_MANAGER 环境变量禁用。
|
||||||
- IDF_PATH - ESP-IDF 路径;由 IDF_PATH 环境变量设置,或者从 ``idf.cmake`` 的位置推断。
|
- IDF_PATH - ESP-IDF 路径;由 IDF_PATH 环境变量设置,或者从 ``idf.cmake`` 的位置推断。
|
||||||
- IDF_TARGET - 构建的目标芯片;由 ``idf_build_process`` 的目标参数设置。
|
- IDF_TARGET - 构建的目标芯片;由 ``idf_build_process`` 的目标参数设置。
|
||||||
- IDF_VER - ESP-IDF 版本;由版本文件或 IDF_PATH 仓库的 Git 版本设置。
|
- IDF_VER - ESP-IDF 版本;由版本文件或 IDF_PATH 仓库的 Git 版本设置。
|
||||||
|
@@ -731,5 +731,3 @@ Deep-sleep 有如下可配置选项:
|
|||||||
.. only:: esp32c2
|
.. only:: esp32c2
|
||||||
|
|
||||||
平均电流约 4.9 μA
|
平均电流约 4.9 μA
|
||||||
|
|
||||||
|
|
||||||
|
@@ -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
|
.. only:: esp32
|
||||||
|
|
||||||
|
@@ -15,7 +15,7 @@ SPIFFS 是一个用于 SPI NOR flash 设备的嵌入式文件系统,支持磨
|
|||||||
- SPIFFS 并非实时栈,每次写操作耗时不等;
|
- SPIFFS 并非实时栈,每次写操作耗时不等;
|
||||||
- 目前,SPIFFS 尚不支持检测或处理已损坏的块。
|
- 目前,SPIFFS 尚不支持检测或处理已损坏的块。
|
||||||
- SPIFFS 只能稳定地使用约 75% 的指定分区容量。
|
- 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>`_。
|
- 如果 {IDF_TARGET_NAME} 在文件系统操作期间断电,可能会导致 SPIFFS 损坏。但是仍可通过 ``esp_spiffs_check`` 函数恢复文件系统。详情请参阅官方 SPIFFS `FAQ <https://github.com/pellepl/spiffs/wiki/FAQ>`_。
|
||||||
|
|
||||||
|
@@ -1,2 +1 @@
|
|||||||
.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C2.rst
|
.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C2.rst
|
||||||
|
|
@@ -322,4 +322,3 @@ OTA 升级失败排查
|
|||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
|
|
||||||
OTA 升级失败时如何排查(点击放大)
|
OTA 升级失败时如何排查(点击放大)
|
||||||
|
|
||||||
|
@@ -393,4 +393,3 @@ ESP32-S2-Kaluga-1 Kit v1.2
|
|||||||
有关本开发板的更多设计文档,请联系我们的商务部门 sales@espressif.com。
|
有关本开发板的更多设计文档,请联系我们的商务部门 sales@espressif.com。
|
||||||
|
|
||||||
|
|
||||||
|
|
@@ -6,7 +6,7 @@
|
|||||||
驱动程序
|
驱动程序
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
为了细粒度地控制其他组件对外设驱动的依赖,原先位于 `driver` 组件下的驱动程序被拆分到了各自独立的组件中。这些组件包括:
|
为了细粒度地控制其他组件对外设驱动的依赖,原先位于 ``driver`` 组件下的驱动程序被拆分到了各自独立的组件中。这些组件包括:
|
||||||
|
|
||||||
- `esp_driver_gptimer` - 通用定时器驱动
|
- `esp_driver_gptimer` - 通用定时器驱动
|
||||||
- `esp_driver_pcnt` - 脉冲计数器驱动
|
- `esp_driver_pcnt` - 脉冲计数器驱动
|
||||||
@@ -28,7 +28,7 @@
|
|||||||
- `esp_driver_parlio` - 并行 IO 驱动
|
- `esp_driver_parlio` - 并行 IO 驱动
|
||||||
- `esp_driver_usb_serial_jtag` - USB_SERIAL_JTAG 驱动
|
- `esp_driver_usb_serial_jtag` - USB_SERIAL_JTAG 驱动
|
||||||
|
|
||||||
为了兼容性,原来的 `driver` 组件仍然存在,并作为一个 “all-in-one" 的组件,将以上这些 `esp_driver_xyz` 组件注册成自己的公共依赖。换句话说,你无需修改既有项目的 CMake 文件,但是你现在多了一个途径去指定你项目依赖的具体的外设驱动。
|
为了兼容性,原来的 ``driver`` 组件仍然存在,并作为一个 “all-in-one" 的组件,将以上这些 `esp_driver_xyz` 组件注册成自己的公共依赖。换句话说,你无需修改既有项目的 CMake 文件,但是你现在多了一个途径去指定你项目依赖的具体的外设驱动。
|
||||||
|
|
||||||
原来你可能使用 **linker.lf** 指定了一些驱动函数在内存空间的链接位置,但是现在,因为驱动文件的位置发生了挪动,就需要你对 **linker.lf** 文件做出相应的改动的。假如,你的 linker.lf 文件里面有以下的条目:
|
原来你可能使用 **linker.lf** 指定了一些驱动函数在内存空间的链接位置,但是现在,因为驱动文件的位置发生了挪动,就需要你对 **linker.lf** 文件做出相应的改动的。假如,你的 linker.lf 文件里面有以下的条目:
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user