linux-kernel - [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-next>] [day] [month] [year] [list]

Message-Id: <20250730201853.8436-1-kriish.sharma2006@gmail.com>
Date: Wed, 30 Jul 2025 20:18:53 +0000
From: Kriish Sharma <kriish.sharma2006@...il.com>
To: skhan@...uxfoundation.org,
	linux-fsdevel@...r.kernel.org,
	viro@...iv.linux.org.uk,
	brauner@...nel.org,
	jack@...e.cz
Cc: linux-kernel@...r.kernel.org,
	linux-kernel-mentees@...ts.linux.dev,
	Kriish Sharma <kriish.sharma2006@...il.com>
Subject: [PATCH] fs: document 'name' parameter for name_contains_dotdot()

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>
---
 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