* [PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot
@ 2025-08-21 14:18 ssranevjti
2025-08-21 14:44 ` Matthew Wilcox
0 siblings, 1 reply; 2+ messages in thread
From: ssranevjti @ 2025-08-21 14:18 UTC (permalink / raw)
To: viro, brauner, skhan
Cc: jack, masahiroy, nathan, nicolas.schier, linux-fsdevel,
linux-kernel, linux-kbuild, Shaurya Rane
From: Shaurya Rane <ssrane_b23@ee.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@ee.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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot
2025-08-21 14:18 [PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot ssranevjti
@ 2025-08-21 14:44 ` Matthew Wilcox
0 siblings, 0 replies; 2+ messages in thread
From: Matthew Wilcox @ 2025-08-21 14:44 UTC (permalink / raw)
To: ssranevjti
Cc: viro, brauner, skhan, jack, masahiroy, nathan, nicolas.schier,
linux-fsdevel, linux-kernel, linux-kbuild, Shaurya Rane
On Thu, Aug 21, 2025 at 07:48:11PM +0530, ssranevjti@gmail.com wrote:
> From: Shaurya Rane <ssrane_b23@ee.vjti.ac.in>
>
> Add missing @name parameter documentation for name_contains_dotdot()
> to fix the following htmldocs warning:
Sixth. https://lore.kernel.org/linux-fsdevel/aKXB7Ux8_C_IIrkB@casper.infradead.org/
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-08-21 14:44 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-21 14:18 [PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot ssranevjti
2025-08-21 14:44 ` Matthew Wilcox
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).