docs(vfs): update esp_vfs_register_fd api description

Closes https://github.com/espressif/esp-idf/issues/11586
This commit is contained in:
sonika.rathi 2023-11-15 09:31:19 +01:00
parent 72e414105d
commit e15fcd2b28

View File

@ -336,7 +336,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.