Skip to contentSkip to conversation

docs: vfs: clean up after the iterate() removal

PATCH In review Jonathan Corbet 3 participants 3 messages Aug 8, 2023 – Aug 9, 2023

Subsystems (2)
lore
Share & tools
lore

Jonathan Corbet

author maintainer
#0 lore raw

PATCH 1/1 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.

---
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(-)
Documentation/filesystems/locking.rst +0 -1
index 0ca479dbb1cd..aeed0a5a80eb 100644
@@ -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);
Documentation/filesystems/vfs.rst +1 -6
index cb2a97e49872..a751f6d01eb2 100644
@@ -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
Signature · 1 line
2.41.0
#1 lore raw
Quoted 3 lines · Jonathan Corbet

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

Reviewed-by on v1 1/1
#2 lore raw
In reply to Jonathan Corbet
Quoted 8 lines · Jonathan Corbet

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.

---
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,

Quoted 46 lines
 Documentation/filesystems/locking.rst | 1 -
 Documentation/filesystems/vfs.rst     | 7 +------
 2 files changed, 1 insertion(+), 7 deletions(-)
Documentation/filesystems/locking.rst +0 -1
index 0ca479dbb1cd..aeed0a5a80eb 100644
@@ -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);
Documentation/filesystems/vfs.rst +1 -6
index cb2a97e49872..a751f6d01eb2 100644
@@ -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
Signature · 1 line
2.41.0