[PATCH] fs/iomap: document ret parameter of iomap_iter_continue

[PATCH] fs/iomap: document ret parameter of iomap_iter_continue

[Muhammad Mahdi Amirpour]

Document the ret parameter of iomap_iter_continue to avoid a
kernel-doc warning.

Signed-off-by: Muhammad Mahdi Amirpour <ampr.mhd@gmail.com>
---
 fs/iomap/iter.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/fs/iomap/iter.c b/fs/iomap/iter.c
index c445a38b6..fd8791c49 100644
--- a/fs/iomap/iter.c
+++ b/fs/iomap/iter.c
@@ -51,6 +51,7 @@ static inline void iomap_iter_done(struct iomap_iter *iter)
  * @iter: iteration structure
  * @iomap: the mapping that was just processed
  * @srcmap: the source mapping that was just processed
+ * @ret: return value from the previous mapping's ->end() callback
  *
  * Helper normally called via iomap_iter_next(). Called after the previous
  * mapping has been finished to determine whether there is more of the file
-- 
2.55.0

Re: [PATCH] fs/iomap: document ret parameter of iomap_iter_continue

[Christoph Hellwig]

Looks good:

Reviewed-by: Christoph Hellwig <hch@lst.de>

Re: [PATCH] fs/iomap: document ret parameter of iomap_iter_continue

[Jeremy Bingham]

It's a useful documentation only change, and documenting what ret does
there seems useful. For whatever it's worth,

Reviewed-by: Jeremy Bingham <jbingham@gmail.com>