2023-08-08 22:44:08

by Jonathan Corbet

Subject: [PATCH] docs: vfs: clean up after the iterate() removal

Commit 3e3271549670 ("vfs: get rid of old '->iterate' directory operation")
removed the iterate() file_operations member, but neglected to clean up the
associated documentation. Get rid of the leftovers.

Signed-off-by: Jonathan Corbet <[email protected]>
---
If nobody objects (or beats me to it) I'll drop this into docs-next
shortly.

Documentation/filesystems/locking.rst | 1 -
Documentation/filesystems/vfs.rst | 7 +------
2 files changed, 1 insertion(+), 7 deletions(-)

diff --git a/Documentation/filesystems/locking.rst b/Documentation/filesystems/locking.rst
index 0ca479dbb1cd..aeed0a5a80eb 100644
--- a/Documentation/filesystems/locking.rst
+++ b/Documentation/filesystems/locking.rst
@@ -509,7 +509,6 @@ prototypes::
ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
int (*iopoll) (struct kiocb *kiocb, bool spin);
- int (*iterate) (struct file *, struct dir_context *);
int (*iterate_shared) (struct file *, struct dir_context *);
__poll_t (*poll) (struct file *, struct poll_table_struct *);
long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
diff --git a/Documentation/filesystems/vfs.rst b/Documentation/filesystems/vfs.rst
index cb2a97e49872..a751f6d01eb2 100644
--- a/Documentation/filesystems/vfs.rst
+++ b/Documentation/filesystems/vfs.rst
@@ -1074,7 +1074,6 @@ This describes how the VFS can manipulate an open file. As of kernel
ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
int (*iopoll)(struct kiocb *kiocb, bool spin);
- int (*iterate) (struct file *, struct dir_context *);
int (*iterate_shared) (struct file *, struct dir_context *);
__poll_t (*poll) (struct file *, struct poll_table_struct *);
long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
@@ -1126,12 +1125,8 @@ otherwise noted.
``iopoll``
called when aio wants to poll for completions on HIPRI iocbs

-``iterate``
- called when the VFS needs to read the directory contents
-
``iterate_shared``
- called when the VFS needs to read the directory contents when
- filesystem supports concurrent dir iterators
+ called when the VFS needs to read the directory contents

``poll``
called by the VFS when a process wants to check if there is
--
2.41.0

2023-08-09 01:09:26

by Linus Torvalds

Subject: Re: [PATCH] docs: vfs: clean up after the iterate() removal

On Tue, 8 Aug 2023 at 14:00, Jonathan Corbet <[email protected]> wrote:
>
> If nobody objects (or beats me to it) I'll drop this into docs-next
> shortly.

LGTM.

I did grep for old uses of iterate - including in docs - but I clearly
only grepped for the "->iterate()" and ".iterate =" forms.

Linus

2023-08-09 07:30:09

by Christian Brauner

Subject: Re: [PATCH] docs: vfs: clean up after the iterate() removal

On Tue, Aug 08, 2023 at 03:00:52PM -0600, Jonathan Corbet wrote:
> Commit 3e3271549670 ("vfs: get rid of old '->iterate' directory operation")
> removed the iterate() file_operations member, but neglected to clean up the
> associated documentation. Get rid of the leftovers.
>
> Signed-off-by: Jonathan Corbet <[email protected]>
> ---
> If nobody objects (or beats me to it) I'll drop this into docs-next
> shortly.

Looks good to me and yes, feel free to take this through docs ofc,
Reviewed-by: Christian Brauner <[email protected]>

>
> Documentation/filesystems/locking.rst | 1 -
> Documentation/filesystems/vfs.rst | 7 +------
> 2 files changed, 1 insertion(+), 7 deletions(-)
>
> diff --git a/Documentation/filesystems/locking.rst b/Documentation/filesystems/locking.rst
> index 0ca479dbb1cd..aeed0a5a80eb 100644
> --- a/Documentation/filesystems/locking.rst
> +++ b/Documentation/filesystems/locking.rst
> @@ -509,7 +509,6 @@ prototypes::
> ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
> ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
> int (*iopoll) (struct kiocb *kiocb, bool spin);
> - int (*iterate) (struct file *, struct dir_context *);
> int (*iterate_shared) (struct file *, struct dir_context *);
> __poll_t (*poll) (struct file *, struct poll_table_struct *);
> long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
> diff --git a/Documentation/filesystems/vfs.rst b/Documentation/filesystems/vfs.rst
> index cb2a97e49872..a751f6d01eb2 100644
> --- a/Documentation/filesystems/vfs.rst
> +++ b/Documentation/filesystems/vfs.rst
> @@ -1074,7 +1074,6 @@ This describes how the VFS can manipulate an open file. As of kernel
> ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
> ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
> int (*iopoll)(struct kiocb *kiocb, bool spin);
> - int (*iterate) (struct file *, struct dir_context *);
> int (*iterate_shared) (struct file *, struct dir_context *);
> __poll_t (*poll) (struct file *, struct poll_table_struct *);
> long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
> @@ -1126,12 +1125,8 @@ otherwise noted.
> ``iopoll``
> called when aio wants to poll for completions on HIPRI iocbs
>
> -``iterate``
> - called when the VFS needs to read the directory contents
> -
> ``iterate_shared``
> - called when the VFS needs to read the directory contents when
> - filesystem supports concurrent dir iterators
> + called when the VFS needs to read the directory contents
>
> ``poll``
> called by the VFS when a process wants to check if there is
> --
> 2.41.0
>