linux-kernel - [PATCH] docs: fs: fix kernel-doc warning 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>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20250821141811.41965-1-ssrane_b23@ee.vjti.ac.in>
Date: Thu, 21 Aug 2025 19:48:11 +0530
From: ssranevjti@...il.com
To: viro@...iv.linux.org.uk,
	brauner@...nel.org,
	skhan@...uxfoundation.org
Cc: jack@...e.cz,
	masahiroy@...nel.org,
	nathan@...nel.org,
	nicolas.schier@...ux.dev,
	linux-fsdevel@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	linux-kbuild@...r.kernel.org,
	Shaurya Rane <ssrane_b23@...vjti.ac.in>
Subject: [PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot

From: Shaurya Rane <ssrane_b23@...vjti.ac.in>

Add missing @name parameter documentation for name_contains_dotdot()
to fix the following htmldocs warning:

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

Signed-off-by: Shaurya Rane <ssrane_b23@...vjti.ac.in>
---
 include/linux/fs.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/linux/fs.h b/include/linux/fs.h
index d7ab4f96d705..945d04419caf 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 string to check
  *
  * Search for ".." surrounded by either '/' or start/end of string.
  */
-- 
2.34.1