linux-fsdevel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] netfs: Fix documentation comment for netfs_wait_for_outstanding_io()
@ 2024-06-03 18:23 Amit Vadhavana
  0 siblings, 0 replies; only message in thread
From: Amit Vadhavana @ 2024-06-03 18:23 UTC (permalink / raw)
  To: dhowells, jlayton, netfs, linux-fsdevel, linux-kernel; +Cc: skhan, av2082000

Correct the parameter name in the documentation comment of the
netfs_wait_for_outstanding_io() to match the actual function parameter.
This change ensures that the kernel-doc tool can generate accurate
documentation and eliminates any warnings related to parameter mismatches.

kernel-doc warning:
  ./include/linux/netfs.h:532: warning: Function parameter or struct member 'inode' not described in 'netfs_wait_for_outstanding_io'
  ./include/linux/netfs.h:532: warning: Excess function parameter 'ctx' description in 'netfs_wait_for_outstanding_io'

Signed-off-by: Amit Vadhavana <av2082000@gmail.com>
---
 include/linux/netfs.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/netfs.h b/include/linux/netfs.h
index 3ca3906bb8da..5d0288938cc2 100644
--- a/include/linux/netfs.h
+++ b/include/linux/netfs.h
@@ -521,7 +521,7 @@ static inline struct fscache_cookie *netfs_i_cookie(struct netfs_inode *ctx)
 
 /**
  * netfs_wait_for_outstanding_io - Wait for outstanding I/O to complete
- * @ctx: The netfs inode to wait on
+ * @inode: The netfs inode to wait on
  *
  * Wait for outstanding I/O requests of any type to complete.  This is intended
  * to be called from inode eviction routines.  This makes sure that any
-- 
2.25.1


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2024-06-03 18:24 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-06-03 18:23 [PATCH] netfs: Fix documentation comment for netfs_wait_for_outstanding_io() Amit Vadhavana

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).