Skip to contentSkip to conversation

netfs: Fix documentation comment for netfs_wait_for_outstanding_io()

PATCH New Amit Vadhavana 1 participant 1 message Jun 3, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 netfs: Fix documentation comment for netfs_wait_for_outstanding_io()

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'

---
 include/linux/netfs.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/netfs.h +1 -1
index 3ca3906bb8da..5d0288938cc2 100644
@@ -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
Signature · 1 line
2.25.1