Re: [PATCH 5/5] Documentation: iomap: update docs to reflect iomap_iter_next model

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Low] Documentation: iomap: wrong callback typedef names in design.rst
- [Low] Documentation: iomap: stale iomap_ops references and wrong typedef names
--

commit fea07d10310ef7888be3709ed8abf2f597ada915
Author: Joanne Koong <joannelkoong@gmail.com>

Documentation: iomap: update docs to reflect iomap_iter_next model

This commit updates the iomap documentation in design.rst, operations.rst,
and porting.rst to replace references to struct iomap_ops and its
iomap_begin and iomap_end callbacks with the new iomap_iter_next_fn
callback model.

[Severity: Low]
In Documentation/filesystems/iomap/design.rst at lines 379-385 (under the
iomap_iter_next section), the newly added code block documents the callback
typedef prototypes passed to iomap_iter_next() as iomap_begin_fn and
iomap_end_fn.

However, in include/linux/iomap.h at lines 221-232 and 352, the actual
typedefs defined and accepted by iomap_iter_next() are named
iomap_iter_begin_fn and iomap_iter_end_fn.

Should design.rst use iomap_iter_begin_fn and iomap_iter_end_fn here to
match include/linux/iomap.h?

[Severity: Low]
A few places in the updated documentation still refer to iomap ops structs
even though struct iomap_ops (along with per-operation structures such as
xfs_*_iomap_ops in fs/xfs/xfs_iomap.c) was removed in favor of passing
iomap_iter_next_fn callbacks directly:

1. In Documentation/filesystems/iomap/design.rst at line 462 (under the end
section), the text still states that "iomap ops for reads are not likely to
need to supply this function."

2. In Documentation/filesystems/iomap/porting.rst at lines 91-100 (under
 the "How Do I Convert a Filesystem?" section), the guide still advises
breaking the begin function up into "per-operation iomap ops" (citing XFS
as an example) and creating "separate mapping functions and iomap ops for
write operations."

3. In Documentation/filesystems/iomap/operations.rst at lines 714-715
(under the fsdax Deduplication section), dax_remap_file_range_prep() is
still documented as being called "with their own iomap read ops", whereas
dax_remap_file_range_prep() in include/linux/dax.h at line 277 now takes an
iomap_iter_next_fn callback (and "iomap read ops" can be confused with
struct iomap_read_ops).

Should these remaining references to iomap ops be updated to refer to
per-operation iomap_iter_next_fn callbacks and mapping functions instead?

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261027215326.2693300-1-joannelkoong@gmail.com?part=5