Merge branch 'docs/update_CN_trans_fatfs' into 'master'

docs: update CN translation for fatfs.rst

See merge request espressif/esp-idf!15958

docs/en/api-reference/storage/fatfs.rst

@@ -14,6 +14,7 @@ Using FatFs with VFS
 The header file :component_file:`fatfs/vfs/esp_vfs_fat.h` defines the functions for connecting FatFs and VFS.
 
 The function :cpp:func:`esp_vfs_fat_register` allocates a ``FATFS`` structure and registers a given path prefix in VFS. Subsequent operations on files starting with this prefix are forwarded to FatFs APIs.
+
 The function :cpp:func:`esp_vfs_fat_unregister_path` deletes the registration with VFS, and frees the ``FATFS`` structure.
 
 Most applications use the following workflow when working with ``esp_vfs_fat_`` functions:
@@ -29,7 +30,7 @@ Most applications use the following workflow when working with ``esp_vfs_fat_``
 
 4. Call the C standard library and POSIX API functions to perform such actions on files as open, read, write, erase, copy, etc. Use paths starting with the path prefix passed to :cpp:func:`esp_vfs_register` (for example, ``"/sdcard/hello.txt"``). The filesystem uses `8.3 filenames <https://en.wikipedia.org/wiki/8.3_filename>`_ format (SFN) by default. If you need to use long filenames (LFN), enable the :ref:`CONFIG_FATFS_LONG_FILENAMES` option. More details on the FatFs filenames are available `here <http://elm-chan.org/fsw/ff/doc/filename.html>`_.
 
-5. Optionally, by enabling the option :ref:`CONFIG_FATFS_USE_FASTSEEK`, use the POSIX lseek function to perform it faster, the fast seek will not work for files in write mode, so to take advantage of fast seek, you should open (or close and then reopen) the file in read-only mode. 
+5. Optionally, by enabling the option :ref:`CONFIG_FATFS_USE_FASTSEEK`, use the POSIX lseek function to perform it faster, the fast seek will not work for files in write mode, so to take advantage of fast seek, you should open (or close and then reopen) the file in read-only mode.
 
 6. Optionally, call the FatFs library functions directly. In this case, use paths without a VFS prefix (for example, ``"/hello.txt"``).
 
@@ -88,10 +89,12 @@ They provide implementation of disk I/O functions for SD/MMC cards and can be re
 FATFS partition generator
 -------------------------
 
-We provide partition generator for FATFS (:component_file:`wl_fatfsgen.py<fatfs/wl_fatfsgen.py>`)
-which is integrated into the build system and could be easily used in the user project.
+We provide a partition generator for FATFS (:component_file:`wl_fatfsgen.py<fatfs/wl_fatfsgen.py>`) which is integrated into the build system and could be easily used in the user project.
+
 The tool is used to create filesystem images on a host and populate it with content of the specified host folder.
+
 The script is based on the partition generator (:component_file:`fatfsgen.py<fatfs/fatfsgen.py>`) and except for generating partition also initializes wear levelling.
+
 Current implementation supports short file names and FAT12. Long file names, and FAT16 are subjects of the future work.
 
 
@@ -107,11 +110,12 @@ If you prefer generating partition without wear levelling support you can use ``
     fatfs_create_rawflash_image(<partition> <base_dir> [FLASH_IN_PROJECT])
 
 ``fatfs_create_spiflash_image`` respectively ``fatfs_create_rawflash_image`` must be called from project's CMakeLists.txt.
+
 If you decided because of any reason to use ``fatfs_create_rawflash_image`` (without wear levelling support) beware that it supports mounting only in read-only mode in the device.
 
 The arguments of the function are as follows:
 
-1. partition - the name of the partition, you can define in partition table (e.g. :example_file:`storage/fatfsgen/partitions_example.csv`)
+1. partition - the name of the partition as defined in the partition table (e.g. :example_file:`storage/fatfsgen/partitions_example.csv`).
 
 2. base_dir - the directory that will be encoded to FATFS partition and optionally flashed into the device. Beware that you have to specified suitable size of the partition in the partition table.
 

docs/zh_CN/api-reference/storage/fatfs.rst

@@ -14,6 +14,7 @@ FatFs 与 VFS 配合使用
 头文件 :component_file:`fatfs/vfs/esp_vfs_fat.h` 定义了连接 FatFs 和 VFS 的函数。
 
 函数 :cpp:func:`esp_vfs_fat_register` 分配一个 ``FATFS`` 结构，并在 VFS 中注册特定路径前缀。如果文件路径以此前缀开头，则对此文件的后续操作将转至 FatFs API。
+
 函数 :cpp:func:`esp_vfs_fat_unregister_path` 删除在 VFS 中的注册，并释放 ``FATFS`` 结构。
 
 多数应用程序在使用 ``esp_vfs_fat_`` 函数时，采用如下步骤：
@@ -23,7 +24,7 @@ FatFs 与 VFS 配合使用
     - FatFs 驱动编号
     - 一个用于接收指向 ``FATFS`` 结构指针的变量
 
-2. 调用 :cpp:func:`ff_diskio_register` 为步骤 1 中的驱动编号注册磁盘 I/O 驱动；
+2. 调用 :cpp:func:`ff_diskio_register`，为步骤 1 中的驱动编号注册磁盘 I/O 驱动；
 
 3. 调用 FatFs 函数 ``f_mount``，随后调用 ``f_fdisk`` 或 ``f_mkfs``，并使用与传递到 :cpp:func:`esp_vfs_fat_register` 相同的驱动编号挂载文件系统。请参考 `FatFs 文档 <http://www.elm-chan.org/fsw/ff/doc/mount.html>`_，查看更多信息；
 
@@ -84,3 +85,46 @@ FatFs 磁盘 I/O 层
 .. doxygenfunction:: ff_diskio_register_wl_partition
 .. doxygenfunction:: ff_diskio_register_raw_partition
 
+
+FatFs 分区生成器
+-------------------------
+
+我们为 FatFs (:component_file:`wl_fatfsgen.py<fatfs/wl_fatfsgen.py>`) 提供了分区生成器，该生成器集成在构建系统中，方便用户在自己的项目中使用。
+
+该生成器可以在主机上创建文件系统镜像，并用指定的主机文件夹内容对其进行填充。
+
+该脚本是建立在分区生成器的基础上 (:component_file:`fatfsgen.py<fatfs/fatfsgen.py>`)，目前除了可以生成分区外，也可以初始化磨损均衡。
+
+当前支持短文件名和 FAT12。未来计划实现长文件名以及 FAT16。
+
+
+构建系统中使用 FatFs 分区生成器
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+通过调用 ``fatfs_create_partition_image`` 可以直接从 CMake 构建系统中调用 FatFs 分区生成器::
+
+    fatfs_create_spiflash_image(<partition> <base_dir> [FLASH_IN_PROJECT])
+
+如果不希望在生成分区时使用磨损均衡，可以使用 ``fatfs_create_rawflash_image``::
+
+    fatfs_create_rawflash_image(<partition> <base_dir> [FLASH_IN_PROJECT])
+
+``fatfs_create_spiflash_image`` 以及 ``fatfs_create_rawflash_image`` 必须从项目的 CMakeLists.txt 中调用。
+
+如果您决定使用 ``fatfs_create_rawflash_image`` （不支持磨损均衡），请注意它支持在设备中以只读模式安装。
+
+该函数的参数如下：
+
+1. partition - 分区的名称，需要在分区表中定义（如 :example_file:`storage/fatfsgen/partitions_example.csv`）。
+
+2. base_dir - 目录名称，该目录会被编码为 FatFs 分区，也可以选择将其被烧录进设备。但注意必须在分区表中指定合适的分区大小。
+
+3. ``FLASH_IN_PROJECT`` 标志 - 用户可以通过指定 ``FLASH_IN_PROJECT``，选择在执行 ``idf.py flash -p <PORT>`` 时让分区镜像自动与应用程序二进制文件、分区表等一同烧录进设备。
+
+例如::
+
+    fatfs_create_partition_image(my_fatfs_partition my_folder FLASH_IN_PROJECT)
+
+没有指定 FLASH_IN_PROJECT 时也可以生成分区镜像，但是用户需要使用 ``esptool.py`` 或自定义的构建系统目标对其手动烧录。
+
+相关示例请查看 :example:`storage/fatfsgen`。