From: Heinrich Schuchardt <xypron.glpk@gmx.de>
Date: Sun, 13 Oct 2019 08:26:26 +0000 (+0200)
Subject: fs: update fs_close() description
X-Git-Url: http://git.dujemihanovic.xyz/html/static/git-favicon.png?a=commitdiff_plain;h=e4bad9f9f0532d2980eed21be07c8799a0f4b818;p=u-boot.git

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 5a1244d57f..247e954053 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);