From: Kriish Sharma <kriish.sharma2006@gmail.com>
To: skhan@linuxfoundation.org, linux-fsdevel@vger.kernel.org,
viro@zeniv.linux.org.uk, brauner@kernel.org, jack@suse.cz
Cc: linux-kernel@vger.kernel.org,
linux-kernel-mentees@lists.linux.dev,
Kriish Sharma <kriish.sharma2006@gmail.com>
Subject: [PATCH] fs: document 'name' parameter for name_contains_dotdot()
Date: Wed, 30 Jul 2025 20:18:53 +0000 [thread overview]
Message-ID: <20250730201853.8436-1-kriish.sharma2006@gmail.com> (raw)
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>
---
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
next reply other threads:[~2025-07-30 20:19 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-30 20:18 Kriish Sharma [this message]
2025-07-31 11:11 ` [PATCH] fs: document 'name' parameter for name_contains_dotdot() Jan Kara
2025-07-31 11:23 ` Christian Brauner
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=20250730201853.8436-1-kriish.sharma2006@gmail.com \
--to=kriish.sharma2006@gmail.com \
--cc=brauner@kernel.org \
--cc=jack@suse.cz \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--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