linux-kernel - [PATCH] fs: document 'name' parameter in 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>] [day] [month] [year] [list]

Message-Id: <20250819221042.170078-1-parmarjaimin.19@gmail.com>
Date: Wed, 20 Aug 2025 03:40:42 +0530
From: Jaimin Parmar <parmarjaimin.19@...il.com>
To: viro@...iv.linux.org.uk,
	brauner@...nel.org
Cc: jack@...e.cz,
	linux-fsdevel@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	skhan@...uxfoundation.org,
	Jaimin Parmar <parmarjaimin.19@...il.com>
Subject: [PATCH] fs: document 'name' parameter in name_contains_dotdot()

Fix the following kernel-doc warning in include/linux/fs.h:

  WARNING: ./include/linux/fs.h:3287 function parameter 'name' not described in 'name_contains_dotdot'

The function comment for name_contains_dotdot() did not describe its
@name argument.
Updated the function comment by adding @name parameter description.

Fixes: 0da3e3822cfa ("fs: move name_contains_dotdot() to header")
Signed-off-by: Jaimin Parmar <parmarjaimin.19@...il.com>

diff --git a/include/linux/fs.h b/include/linux/fs.h
index d7ab4f96d705..74fe7f445c6c 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -3281,6 +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 name or path string to check
  *
  * Search for ".." surrounded by either '/' or start/end of string.
  */
-- 
2.34.1