summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMorph <39850852+Morph1984@users.noreply.github.com>2021-06-22 21:06:17 +0200
committerMorph <39850852+Morph1984@users.noreply.github.com>2021-06-22 21:07:51 +0200
commit2fa207058ba6cb1c4d519942e5543bd942f03f6c (patch)
tree7231a2d3f66ed0781320ac429a711253dc4f193d
parentvfs_real: Fix Mode to FileAccessMode conversion (diff)
downloadyuzu-2fa207058ba6cb1c4d519942e5543bd942f03f6c.tar
yuzu-2fa207058ba6cb1c4d519942e5543bd942f03f6c.tar.gz
yuzu-2fa207058ba6cb1c4d519942e5543bd942f03f6c.tar.bz2
yuzu-2fa207058ba6cb1c4d519942e5543bd942f03f6c.tar.lz
yuzu-2fa207058ba6cb1c4d519942e5543bd942f03f6c.tar.xz
yuzu-2fa207058ba6cb1c4d519942e5543bd942f03f6c.tar.zst
yuzu-2fa207058ba6cb1c4d519942e5543bd942f03f6c.zip
-rw-r--r--src/common/fs/fs.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/common/fs/fs.h b/src/common/fs/fs.h
index a6c993962..183126de3 100644
--- a/src/common/fs/fs.h
+++ b/src/common/fs/fs.h
@@ -48,7 +48,7 @@ template <typename Path>
*
* Failures occur when:
* - Input path is not valid
- * - Filesystem object at path is not a file
+ * - Filesystem object at path is not a regular file
* - Filesystem at path is read only
*
* @param path Filesystem path
@@ -74,7 +74,7 @@ bool RemoveFile(const Path& path) {
* Failures occur when:
* - One or both input path(s) is not valid
* - Filesystem object at old_path does not exist
- * - Filesystem object at old_path is not a file
+ * - Filesystem object at old_path is not a regular file
* - Filesystem object at new_path exists
* - Filesystem at either path is read only
*
@@ -435,11 +435,13 @@ template <typename Path>
#endif
/**
- * Returns whether a filesystem object at path is a file.
+ * Returns whether a filesystem object at path is a regular file.
+ * A regular file is a file that stores text or binary data.
+ * It is not a directory, symlink, FIFO, socket, block device, or character device.
*
* @param path Filesystem path
*
- * @returns True if a filesystem object at path is a file, false otherwise.
+ * @returns True if a filesystem object at path is a regular file, false otherwise.
*/
[[nodiscard]] bool IsFile(const std::filesystem::path& path);