diff options
author | Heinrich Schuchardt | 2019-10-13 10:26:26 +0200 |
---|---|---|
committer | Heinrich Schuchardt | 2019-10-17 19:19:55 +0200 |
commit | e4bad9f9f0532d2980eed21be07c8799a0f4b818 (patch) | |
tree | 2c1e08af828eacda52870945db615b1a0a1fa963 /include | |
parent | 64f49eb7d0697b73fa271a69832069e591c07acc (diff) |
fs: update fs_close() description
Provide a more detailed description of fs_close().
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'include')
-rw-r--r-- | include/fs.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/include/fs.h b/include/fs.h index 5a1244d57fd..247e9540536 100644 --- a/include/fs.h +++ b/include/fs.h @@ -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); |