[PATCH] fs: document 'name' parameter in name_contains_dotdot()

Jaimin Parmar posted 1 patch 1 month, 2 weeks ago
[PATCH] fs: document 'name' parameter in name_contains_dotdot()
Posted by Jaimin Parmar 1 month, 2 weeks ago
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