fs: update fs_close() description

Provide a more detailed description of fs_close().

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

diff --git a/include/fs.h b/include/fs.h
index 5a1244d57fd2328e2e00e7f6f58b981b7e0253f4..247e9540536ca67b416ef831be6bf36f53da4c4b 100644 (file)
--- 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);