[PATCH] fs: document 'name' parameter for name_contains_dotdot()

[PATCH] fs: document 'name' parameter for name_contains_dotdot()

[Kriish Sharma]

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@gmail.com>
---
 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

Re: [PATCH] fs: document 'name' parameter for name_contains_dotdot()

[Jan Kara]

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@gmail.com>

Sure. Feel free to add:

Reviewed-by: Jan Kara <jack@suse.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@suse.com>
SUSE Labs, CR

Re: [PATCH] fs: document 'name' parameter for name_contains_dotdot()

[Christian Brauner]

On Wed, 30 Jul 2025 20:18:53 +0000, 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.
> 
> 

Applied to the vfs-6.18.misc branch of the vfs/vfs.git tree.
Patches in the vfs-6.18.misc 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.18.misc

[1/1] fs: document 'name' parameter for name_contains_dotdot()
      https://git.kernel.org/vfs/vfs/c/a2e446e55e59