docs(storage): added File system considerations document into the API Guides

This commit is contained in:
Martin Vychodil
2023-07-13 21:59:15 +02:00
parent 56816c1ff4
commit e60f6d024e
8 changed files with 217 additions and 0 deletions
@@ -7,6 +7,7 @@ ESP-IDF 使用 `FatFs <http://elm-chan.org/fsw/ff/00index_e.html>`_ 库来实现
此外,我们对 FatFs 库进行了扩展,新增了支持可插拔磁盘 I/O 调度层,从而允许在运行时将 FatFs 驱动映射到物理磁盘。
.. _using-fatfs-with-vfs:
FatFs 与 VFS 配合使用
----------------------------
@@ -47,6 +48,8 @@ FatFs 与 VFS 配合使用
FAT 文件系统不支持硬链接,因此调用 :cpp:func:`link` 后会复制文件内容(仅适用于 FatFs 卷上的文件)。
.. _using-fatfs-with-vfs-and-sdcards:
FatFs 与 VFS 和 SD 卡配合使用
---------------------------------
@@ -70,6 +73,8 @@ FatFs 组件有以下配置选项:
* :ref:`CONFIG_FATFS_LINK_LOCK` - 如果启用该选项,可保证 API 的线程安全,但如果应用程序需要快速频繁地进行小文件操作(例如将日志记录到文件),则可能有必要禁用该选项。请注意,如果禁用该选项,调用 :cpp:func:`link` 后的复制操作将是非原子的,此时如果在不同任务中对同一卷上的大文件调用 :cpp:func:`link`,则无法确保线程安全。
.. _fatfs-diskio-layer:
FatFs 磁盘 I/O 层
-------------------
@@ -136,6 +141,7 @@ FatFs 分区生成器
相关示例请查看 :example:`storage/fatfsgen`
.. _fatfs-partition-analyzer:
FatFs 分区分析器
------------------
@@ -22,6 +22,8 @@ SPIFFS 是一个用于 SPI NOR flash 设备的嵌入式文件系统,支持磨
工具
-----
.. _spiffs-generator:
``spiffsgen.py``
^^^^^^^^^^^^^^^^