Skip to content

Commit 09aae72

Browse files
committed
docs(storage/fatfs): discrepancies between FATFS and POSIX
Closes #15187
1 parent c7a0e45 commit 09aae72

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,11 @@ Most applications use the following workflow when working with ``esp_vfs_fat_``
4343

4444
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.
4545

46-
.. note::
47-
48-
Because FAT filesystem does not support hardlinks, :cpp:func:`link` copies contents of the file instead. (This only applies to files on FatFs volumes.)
46+
Differences to POSIX standard
47+
-----------------------------
4948

49+
#. :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.)
50+
#. :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.
5051

5152
.. _using-fatfs-with-vfs-and-sdcards:
5253

0 commit comments

Comments
 (0)