From 26d25608b6139ef5dbef6f724591a930dcb79b4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20L=C3=A1ska?= Date: Fri, 1 Mar 2019 09:58:00 +0100 Subject: [PATCH] Fixed documentation for return lfs_dir_read return value. lfs_dir_read breaks the convention of returning non-zero on success, this feature should be at least documented. --- lfs.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lfs.h b/lfs.h index 9c3174e..b346008 100644 --- a/lfs.h +++ b/lfs.h @@ -448,7 +448,8 @@ int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir); // Read an entry in the directory // // Fills out the info structure, based on the specified file or directory. -// Returns a negative error code on failure. +// Returns a positive value on success, 0 at the end of directory, +// or a negative error code on failure. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info); // Change the position of the directory