[PATCH] fs: Add missing parameter docs for name_contains_dotdot()

Sunday Adelodun posted 1 patch 1 month, 2 weeks ago
include/linux/fs.h | 1 +
1 file changed, 1 insertion(+)
[PATCH] fs: Add missing parameter docs for name_contains_dotdot()
Posted by Sunday Adelodun 1 month, 2 weeks ago
Fix kernel-doc warning by adding missing @name
parameter description for the name_contains_dotdot()
function.

Fixes the following warning:

WARNING: ./include/linux/fs.h:3287 function parameter
'name' not described in 'name_contains_dotdot'
Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com>
---
 include/linux/fs.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/linux/fs.h b/include/linux/fs.h
index d7ab4f96d705..48a726839e22 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: the file name or path to check
  *
  * Search for ".." surrounded by either '/' or start/end of string.
  */
-- 
2.43.0
Re: [PATCH] fs: Add missing parameter docs for name_contains_dotdot()
Posted by Al Viro 1 month, 2 weeks ago
On Tue, Aug 19, 2025 at 05:48:22PM +0100, Sunday Adelodun wrote:
> Fix kernel-doc warning by adding missing @name
> parameter description for the name_contains_dotdot()
> function.

See https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?h=fs-next&id=4e021920812d164bb02c30cc40e08a3681b1c755