fs: update fs_close() description

Provide a more detailed description of fs_close().

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt 2019-10-13 10:26:26 +02:00
parent 64f49eb7d0
commit e4bad9f9f0
1 changed files with 6 additions and 1 deletions

View File

@ -40,7 +40,12 @@ int fs_set_blk_dev_with_part(struct blk_desc *desc, int part);
/**
* fs_close() - Unset current block device and partition
*
* Should be paired with either fs_set_blk_dev() or fs_set_dev_with_part()
* fs_close() closes the connection to a file system opened with either
* fs_set_blk_dev() or fs_set_dev_with_part().
*
* Many file functions implicitly call fs_close(), e.g. fs_closedir(),
* fs_exist(), fs_ln(), fs_ls(), fs_mkdir(), fs_read(), fs_size(), fs_write(),
* fs_unlink().
*/
void fs_close(void);