[PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot

ssranevjti@gmail.com posted 1 patch 1 month, 1 week ago
include/linux/fs.h | 1 +
1 file changed, 1 insertion(+)
[PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot
Posted by ssranevjti@gmail.com 1 month, 1 week ago
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
Re: [PATCH] docs: fs: fix kernel-doc warning in name_contains_dotdot
Posted by Matthew Wilcox 1 month, 1 week ago
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/