blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-09 17:19:09 -04:00
Code Issues Projects Releases Wiki Activity

docs(storage/fatfs): discrepancies between FATFS and POSIX

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/15187
This commit is contained in:
Tomáš Rohlínek 2025-02-13 10:08:32 +01:00
parent c7a0e45489
commit 09aae72bfa
No known key found for this signature in database
GPG Key ID: BDE1CEDD10F7E372
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/api-reference/storage/fatfs.rst
View File

@ -43,10 +43,11 @@ Most applications use the following workflow when working with ``esp_vfs_fat_``
The convenience functions :cpp:func:`esp_vfs_fat_sdmmc_mount`, :cpp:func:`esp_vfs_fat_sdspi_mount`, and :cpp:func:`esp_vfs_fat_sdcard_unmount` wrap the steps described above and also handle SD card initialization. These functions are described in the next section. The convenience functions :cpp:func:`esp_vfs_fat_sdmmc_mount`, :cpp:func:`esp_vfs_fat_sdspi_mount`, and :cpp:func:`esp_vfs_fat_sdcard_unmount` wrap the steps described above and also handle SD card initialization. These functions are described in the next section.
.. note:: Differences to POSIX standard
-----------------------------
Because FAT filesystem does not support hardlinks, :cpp:func:`link` copies contents of the file instead. (This only applies to files on FatFs volumes.)
#. :cpp:func:`link`: Because FAT filesystem does not support hardlinks, :cpp:func:`link` copies contents of the file instead. (This only applies to files on FatFs volumes.)
#. :cpp:func:`unlink`: When trying to remove an open file, the operation will either fail with ``EBUSY``, when ``CONFIG_FATFS_FS_LOCK`` is enabled, or the behaviour is undefined (possibly causing FS corruption), if not.
.. _using-fatfs-with-vfs-and-sdcards: .. _using-fatfs-with-vfs-and-sdcards: