index

2024-10-05 20:47:46 -04:00 · 2022-12-26 15:35:28 +08:00 · 2022-12-26 15:35:28 +08:00 · 57a9c67c01
commit 57a9c67c01
parent 0fcd384677
14 changed files with 12 additions and 12 deletions
--- a/docs/en/api-guides/build-system.rst
+++ b/docs/en/api-guides/build-system.rst
@ -610,7 +610,7 @@ Adding Link-Time Dependencies

 .. highlight:: cmake

-The ESP-IDF CMake helper function ``idf_component_add_link_dependency`` adds a link-only dependency between one component and another. In almost all cases, it is better to use the ``PRIV_REQUIRES`` feature in ``idf_component_register`` to create a dependency. However, in some cases, it's necessary to add the link-time dependency of another component to this component, i.e., the reverse order to ``PRIV_REQUIRES`` (for example: :doc:`/api-reference/storage/spi_flash_override_driver`).
+The ESP-IDF CMake helper function ``idf_component_add_link_dependency`` adds a link-only dependency between one component and another. In almost all cases, it is better to use the ``PRIV_REQUIRES`` feature in ``idf_component_register`` to create a dependency. However, in some cases, it's necessary to add the link-time dependency of another component to this component, i.e., the reverse order to ``PRIV_REQUIRES`` (for example: :doc:`/api-reference/peripherals/spi_flash/spi_flash_override_driver`).

 To make another component depend on this component at link time::

--- a/docs/en/api-reference/peripherals/index.rst
+++ b/docs/en/api-reference/peripherals/index.rst
@ -29,7 +29,7 @@ Peripherals API
    sdspi_host
    :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave
    :SOC_SDM_SUPPORTED: sdm
-    spi_flash/spi_flash
+    spi_flash/index
    spi_master
    spi_slave
    :esp32: secure_element
--- a/docs/en/api-reference/peripherals/spi_flash/spi_flash.rst
+++ b/docs/en/api-reference/peripherals/spi_flash/spi_flash.rst
--- a/docs/en/api-reference/storage/index.rst
+++ b/docs/en/api-reference/storage/index.rst
@ -16,7 +16,7 @@ This section contains reference of the high-level storage APIs. They are based o
 .. note::
    It's suggested to use high-level APIs (``esp_partition`` or file system) instead of low-level driver APIs to access the SPI NOR Flash.

-    Due to the restriction of NOR Flash and ESP hardware, accessing the main flash will affect the performance of the whole system. See :doc:`SPI Flash Documents </api-reference/peripherals/spi_flash/spi_flash>` to learn more about the limitations.
+    Due to the restriction of NOR Flash and ESP hardware, accessing the main flash will affect the performance of the whole system. See :doc:`SPI Flash Documents </api-reference/peripherals/spi_flash/index>` to learn more about the limitations.

 .. toctree::
    :maxdepth: 1
--- a/docs/en/api-reference/storage/partition.rst
+++ b/docs/en/api-reference/storage/partition.rst
@ -6,7 +6,7 @@ Partitions API
 Overview
 --------

-The ``esp_partition`` component has higher-level API functions which work with partitions defined in the :doc:`partition table </api-guides/partition-tables>`. These APIs are based on lower level API provided by :doc:`SPI Flash driver </api-reference/peripherals/spi_flash/spi_flash>`.
+The ``esp_partition`` component has higher-level API functions which work with partitions defined in the :doc:`partition table </api-guides/partition-tables>`. These APIs are based on lower level API provided by :doc:`SPI Flash driver </api-reference/peripherals/spi_flash/index>`.

 .. _flash-partition-apis:

--- a/docs/en/api-reference/system/ota.rst
+++ b/docs/en/api-reference/system/ota.rst
@ -296,7 +296,7 @@ See also

 * :doc:`Partition Table documentation <../../api-guides/partition-tables>`
 * :doc:`Partition API <../storage/partition>`
-* :doc:`Lower-Level SPI Flash API <../peripherals/spi_flash/spi_flash>`
+* :doc:`Lower-Level SPI Flash API <../peripherals/spi_flash/index>`
 * :doc:`ESP HTTPS OTA <esp_https_ota>`

 Application Example
--- a/docs/en/api-reference/system/wdts.rst
+++ b/docs/en/api-reference/system/wdts.rst
@ -99,7 +99,7 @@ The default timeout period for the TWDT is set using config item :ref:`CONFIG_ES
    - Increase :ref:`CONFIG_ESP_TASK_WDT_TIMEOUT_S` in menuconfig for a larger watchdog timeout period.
    - You can also call :cpp:func:`esp_task_wdt_init` to increase the watchdog timeout period before erasing a large flash area.

-    For more information, you can refer to :doc:`SPI Flash <../peripherals/spi_flash/spi_flash>`.
+    For more information, you can refer to :doc:`SPI Flash <../peripherals/spi_flash/index>`.

 The following config options control TWDT configuration. They are all enabled by default:

--- a/docs/page_redirects.txt
+++ b/docs/page_redirects.txt
@ -23,7 +23,7 @@ api-reference/wifi/esp_smartconfig              api-reference/network/esp_smartc
 api-reference/wifi/esp_wifi                     api-reference/network/esp_wifi
 api-reference/system/tcpip_adapter              migration-guides/tcpip-adapter
 api-reference/system/esp_pthread                api-reference/system/pthread
-api-reference/storage/spi_flash                 api-reference/peripherals/spi_flash/spi_flash
+api-reference/storage/spi_flash                 api-reference/peripherals/spi_flash/index
 api-reference/storage/spi_flash_concurrency     api-reference/peripherals/spi_flash/spi_flash_concurrency
 api-reference/storage/spi_flash_override_driver api-reference/peripherals/spi_flash/spi_flash_override_driver
 api-reference/storage/spi_flash_optional_feature    api-reference/peripherals/spi_flash/spi_flash_optional_feature
--- a/docs/zh_CN/api-guides/build-system.rst
+++ b/docs/zh_CN/api-guides/build-system.rst
@ -610,7 +610,7 @@ CMake 通常会在链接器命令行上重复两次组件库名称来自动处

 .. highlight:: cmake

-ESP-IDF 的 CMake 辅助函数 ``idf_component_add_link_dependency`` 可以在组件之间添加仅作用于链接时的依赖关系。绝大多数情况下，我们都建议您使用 ``idf_component_register`` 中的 ``PRIV_REQUIRES`` 功能来构建依赖关系。然而在某些情况下，还是有必要添加另一个组件对当前组件的链接时依赖，即反转 ``PRIV_REQUIRES`` 中的依赖关系（参考示例：:doc:`/api-reference/storage/spi_flash_override_driver`）。
+ESP-IDF 的 CMake 辅助函数 ``idf_component_add_link_dependency`` 可以在组件之间添加仅作用于链接时的依赖关系。绝大多数情况下，我们都建议您使用 ``idf_component_register`` 中的 ``PRIV_REQUIRES`` 功能来构建依赖关系。然而在某些情况下，还是有必要添加另一个组件对当前组件的链接时依赖，即反转 ``PRIV_REQUIRES`` 中的依赖关系（参考示例：:doc:`/api-reference/peripherals/spi_flash/spi_flash_override_driver`）。

 要使另一个组件在链接时依赖于这个组件::

--- a/docs/zh_CN/api-reference/peripherals/index.rst
+++ b/docs/zh_CN/api-reference/peripherals/index.rst
@ -29,7 +29,7 @@
    sdspi_host
    :SOC_SDIO_SLAVE_SUPPORTED: sdio_slave
    :SOC_SDM_SUPPORTED: sdm
-    spi_flash/spi_flash
+    spi_flash/index
    spi_master
    spi_slave
    :esp32: secure_element
--- a/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash.rst
+++ b/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash.rst
--- a/docs/zh_CN/api-reference/storage/index.rst
+++ b/docs/zh_CN/api-reference/storage/index.rst
@ -15,7 +15,7 @@
 .. note::
    建议使用高层次的 API （ ``esp_partition`` 或者文件系统）而非低层次驱动 API 去访问 SPI NOR Flash 。

-    由于 NOR Flash 和乐鑫硬件的一些限制，访问主 Flash 会影响各个系统的性能。关于这些限制的更多信息，参见 :doc:`SPI Flash Documents </api-reference/peripherals/spi_flash/spi_flash>` 。
+    由于 NOR Flash 和乐鑫硬件的一些限制，访问主 Flash 会影响各个系统的性能。关于这些限制的更多信息，参见 :doc:`SPI Flash Documents </api-reference/peripherals/spi_flash/index>` 。
 .. toctree::
   :maxdepth: 1

--- a/docs/zh_CN/api-reference/storage/partition.rst
+++ b/docs/zh_CN/api-reference/storage/partition.rst
@ -3,7 +3,7 @@

 概述
 --------
-``esp_partition`` 组件提供了高层次的 API 函数，用于访问定义在 :doc:`分区表 </api-guides/partition-tables>` 中的分区。这些 API 基于 :doc:`SPI Flash 驱动 </api-reference/peripherals/spi_flash/spi_flash>` 提供的低层次 API。
+``esp_partition`` 组件提供了高层次的 API 函数，用于访问定义在 :doc:`分区表 </api-guides/partition-tables>` 中的分区。这些 API 基于 :doc:`SPI Flash 驱动 </api-reference/peripherals/spi_flash/index>` 提供的低层次 API。



--- a/docs/zh_CN/api-reference/system/ota.rst
+++ b/docs/zh_CN/api-reference/system/ota.rst
@ -296,7 +296,7 @@ Python API

 * :doc:`分区表 <../../api-guides/partition-tables>`
 * :doc:`分区表 API <../storage/partition>`
-* :doc:`低层 SPI Flash API <../peripherals/spi_flash/spi_flash>`
+* :doc:`低层 SPI Flash API <../peripherals/spi_flash/index>`
 * :doc:`ESP HTTPS OTA <esp_https_ota>`

 应用程序示例