diff --git a/docs/en/api-reference/storage/wear-levelling.rst b/docs/en/api-reference/storage/wear-levelling.rst index c9a25c9196..b1f46f3f12 100644 --- a/docs/en/api-reference/storage/wear-levelling.rst +++ b/docs/en/api-reference/storage/wear-levelling.rst @@ -3,15 +3,15 @@ See Also -------- -- :doc:`FAT Filesystem <./fatfs>` -- :doc:`Partition Table documentation <../../api-guides/partition-tables>` +- :doc:`./fatfs` +- :doc:`../../api-guides/partition-tables` Application Example ------------------- -An example which combines the wear levelling driver with the FATFS library is provided in the :example:`storage/wear_levelling` directory. This example initializes the wear levelling driver, mounts FATFS partition, as well as writes and reads data from it using POSIX and C library APIs. See the :example_file:`storage/wear_levelling/README.md` file for more information. +An example that combines the wear levelling driver with the FATFS library is provided in the :example:`storage/wear_levelling` directory. This example initializes the wear levelling driver, mounts FatFs partition, as well as writes and reads data from it using POSIX and C library APIs. See :example_file:`storage/wear_levelling/README.md` for more information. -High-Level API Reference +High-level API Reference ------------------------ Header Files @@ -19,10 +19,9 @@ Header Files * :component_file:`fatfs/vfs/esp_vfs_fat.h` -High level wear-levelling functions :cpp:func:`esp_vfs_fat_spiflash_mount_rw_wl`, :cpp:func:`esp_vfs_fat_spiflash_unmount_rw_wl` and struct :cpp:class:`esp_vfs_fat_mount_config_t` are described in :doc:`FAT Filesystem ` documentation page. +High-level wear levelling functions :cpp:func:`esp_vfs_fat_spiflash_mount_rw_wl`, :cpp:func:`esp_vfs_fat_spiflash_unmount_rw_wl` and struct :cpp:class:`esp_vfs_fat_mount_config_t` are described in :doc:`./fatfs`. -Mid-Level API Reference +Mid-level API Reference ----------------------- .. include-build-file:: inc/wear_levelling.inc - diff --git a/docs/zh_CN/api-reference/storage/fatfs.rst b/docs/zh_CN/api-reference/storage/fatfs.rst index a44075c5ad..9b82125639 100644 --- a/docs/zh_CN/api-reference/storage/fatfs.rst +++ b/docs/zh_CN/api-reference/storage/fatfs.rst @@ -42,7 +42,7 @@ FatFs 与 VFS 配合使用 10. 调用 :cpp:func:`esp_vfs_fat_unregister_path` 并使用文件系统挂载的路径将 FatFs 从 VFS 中移除,并释放步骤 1 中分配的 ``FATFS`` 结构。 -便捷函数 :cpp:func:`esp_vfs_fat_sdmmc_mount`, :cpp:func:`esp_vfs_fat_sdspi_mount` 和 :cpp:func:`esp_vfs_fat_sdcard_unmount` 对上述步骤进行了封装,并加入了对 SD 卡初始化的处理。我们将在下一章节详细介绍以上函数。 +便捷函数 :cpp:func:`esp_vfs_fat_sdmmc_mount`、:cpp:func:`esp_vfs_fat_sdspi_mount` 和 :cpp:func:`esp_vfs_fat_sdcard_unmount` 对上述步骤进行了封装,并加入了对 SD 卡初始化的处理。我们将在下一章节详细介绍以上函数。 FatFs 与 VFS 和 SD 卡配合使用 diff --git a/docs/zh_CN/api-reference/storage/wear-levelling.rst b/docs/zh_CN/api-reference/storage/wear-levelling.rst index fa7385f6a3..830bcc077e 100644 --- a/docs/zh_CN/api-reference/storage/wear-levelling.rst +++ b/docs/zh_CN/api-reference/storage/wear-levelling.rst @@ -3,10 +3,10 @@ 另请参阅 ----------- -- :doc:`FAT 文件系统 <./fatfs>` -- :doc:`分区表 <../../api-guides/partition-tables>` +- :doc:`./fatfs` +- :doc:`../../api-guides/partition-tables` -应用示例 +应用示例 ------------------- :example:`storage/wear_levelling` 中提供了一款磨损均衡驱动与 FatFs 库结合使用的示例。该示例初始化磨损均衡驱动,挂载 FAT 文件系统分区,并使用 POSIX(可移植操作系统接口)和 C 库 API 从中写入和读取数据。如需了解更多信息,请参考 :example_file:`storage/wear_levelling/README.md`。 @@ -19,16 +19,9 @@ * :component_file:`fatfs/vfs/esp_vfs_fat.h` -函数 -^^^^^^^^^ - -.. doxygenfunction:: esp_vfs_fat_spiflash_mount_rw_wl -.. doxygenstruct:: esp_vfs_fat_mount_config_t - :members: -.. doxygenfunction:: esp_vfs_fat_spiflash_unmount_rw_wl +有关高级磨损均衡函数 :cpp:func:`esp_vfs_fat_spiflash_mount_rw_wl`、 :cpp:func:`esp_vfs_fat_spiflash_unmount_rw_wl` 和结构体 :cpp:class:`esp_vfs_fat_mount_config_t` 的详细内容,请参见 :doc:`./fatfs`。 中层 API 参考 ----------------------- .. include-build-file:: inc/wear_levelling.inc -