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

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

Shrikant Raskar posted 1 patch 1 month, 2 weeks ago

Diff against v1
Download mbox

There is a newer version of this series

include/linux/fs.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Expand all Fold all

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

Posted by Shrikant Raskar 1 month, 2 weeks ago

Adds a brief description of the 'name' parameter to resolve
the kernel-doc warning.

Signed-off-by: Shrikant Raskar <raskar.shree97@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..9f5c91962e85 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 or path string 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] fs: document 'name' parameter in name_contains_dotdot()

Posted by Al Viro 1 month, 2 weeks ago

On Mon, Aug 18, 2025 at 11:56:52PM +0530, Shrikant Raskar wrote:
> Adds a brief description of the 'name' parameter to resolve
> the kernel-doc warning.

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