fs: update fs_close() description

Provide a more detailed description of fs_close(). Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

fs: update fs_close() description
Provide a more detailed description of fs_close(). Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Heinrich Schuchardt
1 parent 64f49eb7d0
Showing 1 changed file with 6 additions and 1 deletions Side-by-side Diff
include/fs.h
@@ -40,7 +40,12 @@
 /**
  * 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);
...	...	@@ -40,7 +40,12 @@
40	40	/**
41	41	* fs_close() - Unset current block device and partition
42	42	*
43		- * Should be paired with either fs_set_blk_dev() or fs_set_dev_with_part()
	43	+ * fs_close() closes the connection to a file system opened with either
	44	+ * fs_set_blk_dev() or fs_set_dev_with_part().
	45	+ *
	46	+ * Many file functions implicitly call fs_close(), e.g. fs_closedir(),
	47	+ * fs_exist(), fs_ln(), fs_ls(), fs_mkdir(), fs_read(), fs_size(), fs_write(),
	48	+ * fs_unlink().
44	49	*/
45	50	void fs_close(void);
46	51