linux-fsdevel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2] VFS: namei: fix start_dirop() kernel-doc warnings
@ 2025-11-28 22:06 Randy Dunlap
  0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2025-11-28 22:06 UTC (permalink / raw)
  To: linux-fsdevel
  Cc: Randy Dunlap, NeilBrown, Christian Brauner, Alexander Viro,
	Jan Kara

Move the kernel-doc function description from just prior to __start_dirop()
to just before start_dirop() to avoid these kernel-doc warnings:

Warning: fs/namei.c:2853 function parameter 'state' not described
 in '__start_dirop'
WARNING: fs/namei.c:2853 expecting prototype for start_dirop().
 Prototype was for __start_dirop() instead

Fixes: ff7c4ea11a05 ("VFS: add start_creating_killable() and start_removing_killable()")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v2: move kernel-doc to start_dirop() instead of __start_dirop() [Neil]
---
Cc: NeilBrown <neil@brown.name>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Jan Kara <jack@suse.cz>
---
 fs/namei.c |   25 ++++++++++++-------------
 1 file changed, 12 insertions(+), 13 deletions(-)

--- linux-next-20251127.orig/fs/namei.c
+++ linux-next-20251127/fs/namei.c
@@ -2835,19 +2835,6 @@ static int filename_parentat(int dfd, st
 	return __filename_parentat(dfd, name, flags, parent, last, type, NULL);
 }
 
-/**
- * start_dirop - begin a create or remove dirop, performing locking and lookup
- * @parent:       the dentry of the parent in which the operation will occur
- * @name:         a qstr holding the name within that parent
- * @lookup_flags: intent and other lookup flags.
- *
- * The lookup is performed and necessary locks are taken so that, on success,
- * the returned dentry can be operated on safely.
- * The qstr must already have the hash value calculated.
- *
- * Returns: a locked dentry, or an error.
- *
- */
 static struct dentry *__start_dirop(struct dentry *parent, struct qstr *name,
 				    unsigned int lookup_flags,
 				    unsigned int state)
@@ -2869,6 +2856,18 @@ static struct dentry *__start_dirop(stru
 	return dentry;
 }
 
+/**
+ * start_dirop - begin a create or remove dirop, performing locking and lookup
+ * @parent:       the dentry of the parent in which the operation will occur
+ * @name:         a qstr holding the name within that parent
+ * @lookup_flags: intent and other lookup flags.
+ *
+ * The lookup is performed and necessary locks are taken so that, on success,
+ * the returned dentry can be operated on safely.
+ * The qstr must already have the hash value calculated.
+ *
+ * Returns: a locked dentry, or an error.
+ */
 struct dentry *start_dirop(struct dentry *parent, struct qstr *name,
 			   unsigned int lookup_flags)
 {

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

only message in thread, other threads:[~2025-11-28 22:06 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-28 22:06 [PATCH v2] VFS: namei: fix start_dirop() kernel-doc warnings Randy Dunlap

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).