From: André Schröder <andre.schroeder@andresco.de>
Date: Mon, 18 Apr 2022 21:28:27 +0000 (+0200)
Subject: patch: document ignored fill parameter of readdir
X-Git-Tag: fuse-3.11.0~1
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=96ad05c8e12bae3c53401d4a856c168ef6c04345;p=qemu-gpiodev%2Flibfuse.git

patch: document ignored fill parameter of readdir
---

diff --git a/include/fuse.h b/include/fuse.h
index 9148688..1a2f841 100644
--- a/include/fuse.h
+++ b/include/fuse.h
@@ -563,6 +563,13 @@ struct fuse_operations {
 	 * passes non-zero offset to the filler function.  When the buffer
 	 * is full (or an error happens) the filler function will return
 	 * '1'.
+	 *
+	 * When FUSE_READDIR_PLUS is not set, only some parameters of the
+	 * fill function (the fuse_fill_dir_t parameter) are actually used:
+	 * The file type (which is part of stat::st_mode) is used. And if
+	 * fuse_config::use_ino is set, the inode (stat::st_ino) is also
+	 * used. The other fields are ignored when FUSE_READDIR_PLUS is not
+	 * set.
 	 */
 	int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
 			struct fuse_file_info *, enum fuse_readdir_flags);