[PATCH] Documentation: warning fix

Pavan Bobba posted 1 patch 1 month, 2 weeks ago
include/linux/fs.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] Documentation: warning fix
Posted by Pavan Bobba 1 month, 2 weeks ago
This fix is to mitigate below warning while generating documentation

WARNING: ./include/linux/fs.h:3287 function parameter 'name' not described in 'name_contains_dotdot'
Signed-off-by: Pavan Bobba <opensource206@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 d7ab4f96d705..1c87f9861ce2 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -3281,7 +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 to check
  * Search for ".." surrounded by either '/' or start/end of string.
  */
 static inline bool name_contains_dotdot(const char *name)
-- 
2.43.0
Re: [PATCH] Documentation: warning fix
Posted by Matthew Wilcox 1 month, 2 weeks ago
On Wed, Aug 20, 2025 at 05:57:37PM +0530, Pavan Bobba wrote:
> This fix is to mitigate below warning while generating documentation

You're the fifth.  You know you can read mailing lists as well as
send to them?  Also, reviews are more useful than new patches.

https://lore.kernel.org/linux-fsdevel/?q=name_contains_dotdot