linux-kernel - Re: [PATCH] fs: document 'name' parameter for name_contains

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <oo4phoyuqa7g4d4y76rekvkwjyndgovny4u2h4tk5klzt5dsyq@3cnq5fneh23l>
Date: Thu, 31 Jul 2025 13:11:46 +0200
From: Jan Kara <jack@...e.cz>
To: Kriish Sharma <kriish.sharma2006@...il.com>
Cc: skhan@...uxfoundation.org, linux-fsdevel@...r.kernel.org, 
	viro@...iv.linux.org.uk, brauner@...nel.org, jack@...e.cz, linux-kernel@...r.kernel.org, 
	linux-kernel-mentees@...ts.linux.dev
Subject: Re: [PATCH] fs: document 'name' parameter for name_contains_dotdot()

On Wed 30-07-25 20:18:53, Kriish Sharma wrote:
> The kernel-doc for name_contains_dotdot() was missing the @name
> parameter description, leading to a warning during make htmldocs.
> 
> Add the missing documentation to resolve this warning.
> 
> Signed-off-by: Kriish Sharma <kriish.sharma2006@...il.com>

Sure. Feel free to add:

Reviewed-by: Jan Kara <jack@...e.cz>

								Honza

> ---
>  include/linux/fs.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/fs.h b/include/linux/fs.h
> index 2ec4807d4ea8..d7d311b99438 100644
> --- a/include/linux/fs.h
> +++ b/include/linux/fs.h
> @@ -3279,7 +3279,7 @@ static inline bool is_dot_dotdot(const char *name, size_t len)
>  
>  /**
>   * name_contains_dotdot - check if a file name contains ".." path components
> - *
> + * @name: File path string to check
>   * Search for ".." surrounded by either '/' or start/end of string.
>   */
>  static inline bool name_contains_dotdot(const char *name)
> -- 
> 2.34.1
> 
-- 
Jan Kara <jack@...e.com>
SUSE Labs, CR