linux-kernel - Re: [PATCH 2/2] VFS: fix __start

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-id: <176681070372.16766.3882354586761538831@noble.neil.brown.name>
Date: Sat, 27 Dec 2025 15:45:03 +1100
From: NeilBrown <neilb@...mail.net>
To: "Bagas Sanjaya" <bagasdotme@...il.com>
Cc: "Linux Kernel Mailing List" <linux-kernel@...r.kernel.org>,
 "Linux Filesystems Development" <linux-fsdevel@...r.kernel.org>,
 "Alexander Viro" <viro@...iv.linux.org.uk>,
 "Christian Brauner" <brauner@...nel.org>, "Jan Kara" <jack@...e.cz>,
 "Mateusz Guzik" <mjguzik@...il.com>, "Jeff Layton" <jlayton@...nel.org>,
 "Amir Goldstein" <amir73il@...il.com>, "Bagas Sanjaya" <bagasdotme@...il.com>
Subject: Re: [PATCH 2/2] VFS: fix __start_dirop() kernel-doc warnings

On Fri, 19 Dec 2025, Bagas Sanjaya wrote:
> Sphinx report 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
> 
> Fix them up.
> 
> Fixes: ff7c4ea11a05c8 ("VFS: add start_creating_killable() and start_removing_killable()")
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  fs/namei.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/fs/namei.c b/fs/namei.c
> index bf0f66f0e9b92c..91fd3a786704e2 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -2836,10 +2836,11 @@ static int filename_parentat(int dfd, struct filename *name,
>  }
>  
>  /**
> - * start_dirop - begin a create or remove dirop, performing locking and lookup
> + * __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.
> + * @state:        task state bitmask

I would really rather the doco comment was moved to be before
start_dirop(), and left unchanged.

Otherwise we would really need to actually docoument "@state", not just
add vague words to shut the checker up.

There was already been a patch posted to do this.

NeilBrown


>   *
>   * The lookup is performed and necessary locks are taken so that, on success,
>   * the returned dentry can be operated on safely.
> -- 
> An old man doll... just what I always wanted! - Clara
> 
>