[PATCH] filelock: __fcntl_getlease: fix kernel-doc warnings

[PATCH] filelock: __fcntl_getlease: fix kernel-doc warnings

[Randy Dunlap]

Use the correct function name and add description for the @flavor
parameter to avoid these kernel-doc warnings:

Warning: fs/locks.c:1706 function parameter 'flavor' not described in
 '__fcntl_getlease'
WARNING: fs/locks.c:1706 expecting prototype for fcntl_getlease().
 Prototype was for __fcntl_getlease() instead

Fixes: 1602bad16d7d ("vfs: expose delegation support to userland")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Feel free to correct (or tell me) a better description for @flavor.

Cc: Jeff Layton <jlayton@kernel.org>
Cc: Chuck Lever <chuck.lever@oracle.com>
Cc: Alexander Aring <alex.aring@gmail.com>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Jan Kara <jack@suse.cz>
---
 fs/locks.c |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20251127.orig/fs/locks.c
+++ linux-next-20251127/fs/locks.c
@@ -1681,8 +1681,9 @@ void lease_get_mtime(struct inode *inode
 EXPORT_SYMBOL(lease_get_mtime);
 
 /**
- *	fcntl_getlease - Enquire what lease is currently active
+ *	__fcntl_getlease - Enquire what lease is currently active
  *	@filp: the file
+ *	@flavor: type of lease flags to check
  *
  *	The value returned by this function will be one of
  *	(if no lease break is pending):

Re: [PATCH] filelock: __fcntl_getlease: fix kernel-doc warnings

[Christian Brauner]

On Thu, 27 Nov 2025 16:08:26 -0800, Randy Dunlap wrote:
> Use the correct function name and add description for the @flavor
> parameter to avoid these kernel-doc warnings:
> 
> Warning: fs/locks.c:1706 function parameter 'flavor' not described in
>  '__fcntl_getlease'
> WARNING: fs/locks.c:1706 expecting prototype for fcntl_getlease().
>  Prototype was for __fcntl_getlease() instead
> 
> [...]

Applied to the vfs-6.19.directory.delegations branch of the vfs/vfs.git tree.
Patches in the vfs-6.19.directory.delegations branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs-6.19.directory.delegations

[1/1] filelock: __fcntl_getlease: fix kernel-doc warnings
      https://git.kernel.org/vfs/vfs/c/01c9c30aae31