From: Jaimin Parmar <parmarjaimin.19@gmail.com>
To: viro@zeniv.linux.org.uk, brauner@kernel.org
Cc: jack@suse.cz, linux-fsdevel@vger.kernel.org,
linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
Jaimin Parmar <parmarjaimin.19@gmail.com>
Subject: [PATCH] fs: document 'name' parameter in name_contains_dotdot()
Date: Wed, 20 Aug 2025 03:40:42 +0530 [thread overview]
Message-ID: <20250819221042.170078-1-parmarjaimin.19@gmail.com> (raw)
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@gmail.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
next reply other threads:[~2025-08-19 22:10 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-19 22:10 Jaimin Parmar [this message]
-- strict thread matches above, loose matches on Subject: below --
2025-08-23 14:22 [PATCH] fs: Document 'name' parameter in name_contains_dotdot() Prithvi Tambewagh
2025-08-24 1:06 ` Al Viro
2025-08-24 1:52 ` Eric Biggers
2025-08-24 3:10 ` Al Viro
2025-08-18 18:26 [PATCH] fs: document " Shrikant Raskar
2025-08-19 17:15 ` Al Viro
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250819221042.170078-1-parmarjaimin.19@gmail.com \
--to=parmarjaimin.19@gmail.com \
--cc=brauner@kernel.org \
--cc=jack@suse.cz \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=viro@zeniv.linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).