forked from espressif/esp-idf
docs(storage/fatfs): fix fatfs example links in docs
This commit is contained in:
committed by
Tomas Rohlinek
parent
ebe5ac900b
commit
908c4c7ce6
@@ -105,7 +105,7 @@ The most supported file system, recommended for common applications - file/direc
|
|||||||
**Examples:**
|
**Examples:**
|
||||||
|
|
||||||
* :example:`storage/sd_card`: access the SD card which uses the FAT file system
|
* :example:`storage/sd_card`: access the SD card which uses the FAT file system
|
||||||
* :example:`storage/ext_flash_fatfs`: access the external flash chip which uses the FAT file system
|
* :example:`storage/fatfs/ext_flash`: access the external flash chip which uses the FAT file system
|
||||||
|
|
||||||
|
|
||||||
.. _spiffs-fs-section:
|
.. _spiffs-fs-section:
|
||||||
|
@@ -301,9 +301,9 @@ Improving I/O Performance
|
|||||||
|
|
||||||
Using standard C library functions like ``fread`` and ``fwrite`` instead of platform-specific unbuffered syscalls such as ``read`` and ``write``, may result in slower performance.
|
Using standard C library functions like ``fread`` and ``fwrite`` instead of platform-specific unbuffered syscalls such as ``read`` and ``write``, may result in slower performance.
|
||||||
|
|
||||||
The ``fread`` and ``fwrite`` functions are designed for portability rather than speed, introducing some overhead due to their buffered nature. Check the example :example:`storage/fatfsgen` to see how to use these two functions.
|
The ``fread`` and ``fwrite`` functions are designed for portability rather than speed, introducing some overhead due to their buffered nature. Check the example :example:`storage/fatfs/getting_started` to see how to use these two functions.
|
||||||
|
|
||||||
In contrast, the ``read`` and ``write`` functions are standard POSIX APIs that can be used directly when working with FatFs through VFS, with ESP-IDF handling the underlying implementation. Check the example :example:`storage/perf_benchmark` to see how to use the two functions.
|
In contrast, the ``read`` and ``write`` functions are standard POSIX APIs that can be used directly when working with FatFs through VFS, with ESP-IDF handling the underlying implementation. Check the example :example:`storage/fatfs/fs_operations` to see how to use the two functions.
|
||||||
|
|
||||||
Additional tips are provided below, and further details can be found in :doc:`/api-reference/storage/fatfs`.
|
Additional tips are provided below, and further details can be found in :doc:`/api-reference/storage/fatfs`.
|
||||||
|
|
||||||
|
@@ -301,9 +301,9 @@ ESP-IDF 支持动态 :doc:`/api-reference/system/intr_alloc` 和中断抢占。
|
|||||||
|
|
||||||
使用标准 C 库函数,如 ``fread`` 和 ``fwrite``,相较于使用平台特定的不带缓冲系统调用,如 ``read`` 和 ``write``,可能会导致 I/O 性能下降。
|
使用标准 C 库函数,如 ``fread`` 和 ``fwrite``,相较于使用平台特定的不带缓冲系统调用,如 ``read`` 和 ``write``,可能会导致 I/O 性能下降。
|
||||||
|
|
||||||
``fread`` 与 ``fwrite`` 函数是为可移植性而设计的,而非速度,其缓冲性质会引入一些额外的开销。关于如何使用这两个函数,请参考示例 :example:`storage/fatfsgen`。
|
``fread`` 与 ``fwrite`` 函数是为可移植性而设计的,而非速度,其缓冲性质会引入一些额外的开销。关于如何使用这两个函数,请参考示例 :example:`storage/fatfs/getting_started`。
|
||||||
|
|
||||||
与之相比,``read`` 与 ``write`` 函数是标准的 POSIX API,可直接通过 VFS 处理 FatFs,由 ESP-IDF 负责底层实现。关于如何使用这两个函数,请参考示例 :example:`storage/perf_benchmark`。
|
与之相比,``read`` 与 ``write`` 函数是标准的 POSIX API,可直接通过 VFS 处理 FatFs,由 ESP-IDF 负责底层实现。关于如何使用这两个函数,请参考示例 :example:`storage/fatfs/fs_operations`。
|
||||||
|
|
||||||
下面提供了一些提示,更多信息请见 :doc:`/api-reference/storage/fatfs`。
|
下面提供了一些提示,更多信息请见 :doc:`/api-reference/storage/fatfs`。
|
||||||
|
|
||||||
|
@@ -123,7 +123,7 @@ FatFs 分区生成器
|
|||||||
|
|
||||||
该函数的参数如下:
|
该函数的参数如下:
|
||||||
|
|
||||||
#. partition - 分区的名称,需要在分区表中定义(如 :example_file:`storage/fatfsgen/partitions_example.csv`)。
|
#. partition - 分区的名称,需要在分区表中定义(如 :example_file:`storage/fatfs/fatfsgen/partitions_example.csv`)。
|
||||||
|
|
||||||
#. base_dir - 目录名称,该目录会被编码为 FatFs 分区,也可以选择将其被烧录进设备。但注意必须在分区表中指定合适的分区大小。
|
#. base_dir - 目录名称,该目录会被编码为 FatFs 分区,也可以选择将其被烧录进设备。但注意必须在分区表中指定合适的分区大小。
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ FatFs 分区生成器
|
|||||||
|
|
||||||
没有指定 FLASH_IN_PROJECT 时也可以生成分区镜像,但是用户需要使用 ``esptool.py`` 或自定义的构建系统目标对其手动烧录。
|
没有指定 FLASH_IN_PROJECT 时也可以生成分区镜像,但是用户需要使用 ``esptool.py`` 或自定义的构建系统目标对其手动烧录。
|
||||||
|
|
||||||
相关示例请查看 :example:`storage/fatfsgen`。
|
相关示例请查看 :example:`storage/fatfs/fatfsgen`。
|
||||||
|
|
||||||
.. _fatfs-partition-analyzer:
|
.. _fatfs-partition-analyzer:
|
||||||
|
|
||||||
|
@@ -74,7 +74,7 @@
|
|||||||
- **描述**
|
- **描述**
|
||||||
* - :example:`fatfsgen <storage/fatfs/fatfsgen>`
|
* - :example:`fatfsgen <storage/fatfs/fatfsgen>`
|
||||||
- 演示了在主机上使用 Python 工具生成 FATFS 镜像的相关功能。
|
- 演示了在主机上使用 Python 工具生成 FATFS 镜像的相关功能。
|
||||||
* - :example:`ext_flash_fatfs <storage/fatfs/ext_flash_fatfs>`
|
* - :example:`ext_flash_fatfs <storage/fatfs/ext_flash>`
|
||||||
- 演示了在外部 flash 上使用带有损耗均衡功能的 FATFS。
|
- 演示了在外部 flash 上使用带有损耗均衡功能的 FATFS。
|
||||||
* - :example:`wear_leveling <storage/wear_levelling>`
|
* - :example:`wear_leveling <storage/wear_levelling>`
|
||||||
- 演示了在内部 flash 上使用带有损耗均衡功能的 FATFS。
|
- 演示了在内部 flash 上使用带有损耗均衡功能的 FATFS。
|
||||||
|
Reference in New Issue
Block a user