From 33fd7c8af15b309ab3b619a02bd900d9b78c4b0b Mon Sep 17 00:00:00 2001 From: Arshad Hussain Date: Mon, 3 Mar 2025 12:39:42 +0530 Subject: [PATCH] LU-9633 llite: Add kernel doc style for lustre/llite/*.c (Part 5) This patch converts existing functional comments to kernel doc style comments and removes '/**' for comments which is not meant to be a kernel-doc comment Tested: ./kernel-doc -v -none lustre/llite/namei.c lustre/llite/lproc_llite.c llite/namei.c:101: info: Scanning doc for function ll_iget llite/namei.c:1299: info: Scanning doc for function ll_atomic_open llite/lproc_llite.c:83: info: Scanning doc for function ll_stats_pid_write llite/lproc_llite.c:1355: info: Scanning doc for function default_easize_show llite/lproc_llite.c:1383: info: Scanning doc for function default_easize_store Test-Parameters: trivial Signed-off-by: Arshad Hussain Change-Id: I8178ca5c2605341f13e307ef5e194f2b4ba8a5bd Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58277 Tested-by: jenkins Tested-by: Maloo Reviewed-by: James Simmons Reviewed-by: Petros Koutoupis Reviewed-by: Anjus George Reviewed-by: Oleg Drokin --- lustre/llite/lproc_llite.c | 33 +++++++++++++++------------------ lustre/llite/namei.c | 24 ++++++++++++++++++++---- 2 files changed, 35 insertions(+), 22 deletions(-) diff --git a/lustre/llite/lproc_llite.c b/lustre/llite/lproc_llite.c index e481f86..11bc14a 100644 --- a/lustre/llite/lproc_llite.c +++ b/lustre/llite/lproc_llite.c @@ -1351,15 +1351,14 @@ static ssize_t max_easize_show(struct kobject *kobj, LUSTRE_RO_ATTR(max_easize); /** - * Get default_easize. + * default_easize_show() - Show default_easize (EA size) + * @kobj: seq_file handle + * @attr: unused for single entry (attribute structure pointer) + * @buf: xattr(EA) size returned to userspace * - * \see client_obd::cl_default_mds_easize - * - * \param[in] m seq_file handle - * \param[in] v unused for single entry - * - * \retval 0 on success - * \retval negative negated errno on failure + * Return: + * * %0 on success + * * %negative negated errno on failure */ static ssize_t default_easize_show(struct kobject *kobj, struct attribute *attr, @@ -1380,20 +1379,18 @@ static ssize_t default_easize_show(struct kobject *kobj, } /** - * Set default_easize. + * default_easize_store() - Set default_easize. + * @kobj: pointer to a kobject structure + * @attr: unused for single entry (attribute structure pointer) + * @buffer: string passed from user space + * @count: buffer length * * Range checking on the passed value is handled by * ll_set_default_mdsize(). * - * \see client_obd::cl_default_mds_easize - * - * \param[in] file proc file - * \param[in] buffer string passed from user space - * \param[in] count \a buffer length - * \param[in] off unused for single entry - * - * \retval positive \a count on success - * \retval negative negated errno on failure + * Return: + * * %positive count on success + * * %negative negated errno on failure */ static ssize_t default_easize_store(struct kobject *kobj, struct attribute *attr, diff --git a/lustre/llite/namei.c b/lustre/llite/namei.c index d4c486e..62044f6 100644 --- a/lustre/llite/namei.c +++ b/lustre/llite/namei.c @@ -98,8 +98,15 @@ out: /** - * Get an inode by inode number(@hash), which is already instantiated by - * the intent lookup). + * ll_iget() - Get an inode by inode number(@hash), which is already + * instantiated by the intent lookup). + * @sb: Pointer to struct super_block + * @hash: inode number (to be retrived) + * @md: Inode metadata info. + * + * Return: + * * Valid inode struct on Success + * * ERRNO converted by ERR_PTR on Failure */ struct inode *ll_iget(struct super_block *sb, ino_t hash, struct lustre_md *md) @@ -1292,6 +1299,15 @@ do { \ * ll_atomic_open() - For cached negative dentry and new dentry, handle * lookup/create/open together. This method is only called * if the last component is negative(needs lookup) + * @dir: struct inode pointng to directory in which the file is opened/created + * @dentry: struct dentry pointing to the file which is opened/created + * @file: file structure that is associated with the opened file + * @open_flags: Open flags passed from userspace + * @ll_last_arg: depending on kernel version. Is not used or indicates if the + * file was open or created + * + * Return: + * * %0 File successfully opened ERRNO on failure */ static int ll_atomic_open(struct inode *dir, struct dentry *dentry, struct file *file, unsigned int open_flags, @@ -2277,9 +2293,9 @@ out: RETURN(rc); } -/** +/* * Remove dir entry - **/ + */ int ll_rmdir_entry(struct inode *dir, char *name, int namelen) { struct ptlrpc_request *request = NULL; -- 1.8.3.1