]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
fs: document 'name' parameter for name_contains_dotdot()
authorKriish Sharma <kriish.sharma2006@gmail.com>
Wed, 30 Jul 2025 20:18:53 +0000 (20:18 +0000)
committerChristian Brauner <brauner@kernel.org>
Mon, 11 Aug 2025 12:52:25 +0000 (14:52 +0200)
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>
Link: https://lore.kernel.org/20250730201853.8436-1-kriish.sharma2006@gmail.com
Reviewed-by: Jan Kara <jack@suse.cz>
Signed-off-by: Christian Brauner <brauner@kernel.org>
include/linux/fs.h

index 796319914b0a063642c2bd0c0140697a0eb651f6..780e9c774c54963ff9dd6bdb4f3f70e1cc818e12 100644 (file)
@@ -3281,7 +3281,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)