From 78c572bbc31d2c89847485c23b85725886a85f6a Mon Sep 17 00:00:00 2001 From: "sonika.rathi" Date: Wed, 15 Nov 2023 09:31:19 +0100 Subject: [PATCH] docs(vfs): update esp_vfs_register_fd api description Closes https://github.com/espressif/esp-idf/issues/11586 --- components/vfs/include/esp_vfs.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/components/vfs/include/esp_vfs.h b/components/vfs/include/esp_vfs.h index d2634670d4..68adeb94ef 100644 --- a/components/vfs/include/esp_vfs.h +++ b/components/vfs/include/esp_vfs.h @@ -331,7 +331,8 @@ esp_err_t esp_vfs_unregister_with_id(esp_vfs_id_t vfs_id); /** * Special function for registering another file descriptor for a VFS registered - * by esp_vfs_register_with_id. + * by esp_vfs_register_with_id. This function should only be used to register + * permanent file descriptors (socket fd) that are not removed after being closed. * * @param vfs_id VFS identificator returned by esp_vfs_register_with_id. * @param fd The registered file descriptor will be written to this address.