From: Arshad Hussain Date: Mon, 3 Mar 2025 07:29:33 +0000 (+0530) Subject: LU-9633 llite: Add kernel doc style for lustre/llite/*.c (Part 7) X-Git-Tag: 2.16.53~29 X-Git-Url: https://git.whamcloud.com/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F79%2F58279%2F2;p=fs%2Flustre-release.git LU-9633 llite: Add kernel doc style for lustre/llite/*.c (Part 7) 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 ./kernel-doc -v -none lustre/llite/symlink.c lustre/llite/rw26.c llite/symlink.c:244: info: Scanning doc for function ll_getattr_link llite/rw26.c:36: info: Scanning doc for function ll_invalidate_folio llite/rw26.c:92: info: Scanning doc for function ll_invalidatepage llite/rw26.c:719: info: Scanning doc for function ll_prepare_partial_page Test-Parameters: trivial Signed-off-by: Arshad Hussain Change-Id: I9c9fd4c5c1edc426df42165c11c54fdd694bf722 Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58279 Tested-by: jenkins Tested-by: Maloo Reviewed-by: James Simmons Reviewed-by: Petros Koutoupis Reviewed-by: Anjus George Reviewed-by: Oleg Drokin --- diff --git a/lustre/llite/rw26.c b/lustre/llite/rw26.c index baa92ce..b37e5a0 100644 --- a/lustre/llite/rw26.c +++ b/lustre/llite/rw26.c @@ -32,10 +32,14 @@ #ifdef HAVE_INVALIDATE_FOLIO /** - * Implements Linux VM address_space::invalidate_folio() method. This method is - * called when the folio is truncated from a file, either as a result of - * explicit truncate, or when inode is removed from memory (as a result of - * final iput(), umount, or memory pressure induced icache shrinking). + * ll_invalidate_folio() - Implements Linux VM address_space::invalidate_folio() + * method. This method is called when the folio is truncated from a file, either + * as a result of explicit truncate, or when inode is removed from memory + * (as a result of final iput(), umount, or memory pressure induced icache + * shrinking). + * @folio: Pointer to folio struct (collection of pages) + * @offset: Starting offset in bytes + * @len: length of folio to be invalidated * * [0, off] bytes of the folio remain valid (this is for a case of non-page * aligned truncate). Lustre leaves partially truncated folios in the cache, @@ -84,10 +88,14 @@ static void ll_invalidate_folio(struct folio *folio, size_t offset, size_t len) #else /** - * Implements Linux VM address_space::invalidatepage() method. This method is - * called when the page is truncate from a file, either as a result of - * explicit truncate, or when inode is removed from memory (as a result of - * final iput(), umount, or memory pressure induced icache shrinking). + * ll_invalidatepage() - Implements Linux VM address_space::invalidatepage() + * method. This method is called when the page is truncate from a file, either + * as a result of explicit truncate, or when inode is removed from memory + * (as a result of final iput(), umount, or memory pressure induced icache + * shrinking). + * + * @vmpage: pointer to struct page (single page) + * @offset: Starting offset in bytes * * [0, offset] bytes of the page remain valid (this is for a case of not-page * aligned truncate). Lustre leaves partially truncated page in the cache, @@ -707,9 +715,16 @@ ll_direct_IO(int rw, struct kiocb *iocb, const struct iovec *iov, #endif /* !defined(HAVE_DIO_ITER) */ /** - * Prepare partially written-to page for a write. - * @pg is owned when passed in and disowned when it returns non-zero result to - * the caller. + * ll_prepare_partial_page() - Prepare partially written-to page for a write. + * @env: execution environment for this thread + * @io: pointer to the client I/O structure + * @pg: owned when passed in and disowned when it returns non-zero result to + * the caller + * @file: file structure associated with the page + * + * Return: + * * %0: Success (Ready for read/write) + * * %-ERRNO: Failure */ static int ll_prepare_partial_page(const struct lu_env *env, struct cl_io *io, struct cl_page *pg, struct file *file) diff --git a/lustre/llite/symlink.c b/lustre/llite/symlink.c index faedf25..e7ae929 100644 --- a/lustre/llite/symlink.c +++ b/lustre/llite/symlink.c @@ -243,6 +243,13 @@ static const char *ll_follow_link(struct dentry *dentry, void **cookie) /** * ll_getattr_link() - link-specific getattr to set the correct st_size * for encrypted symlinks + * @map: (if HAVE_USER_NAMESPACE_ARG is defined) pointer to struct mnt_idmap + * @path: pointer to struct path (path to symlink) + * @stat: pointer to struct kstat (holds STATX_SIZE, STATX_BLOCKS and + * STATX_MTIME of symlink) + * @request_mask: attributes mask request (STATX_SIZE, BLOCKS, MTIME) see + * ll_getattr_dentry() + * @flags: attribute to get * * Override st_size of encrypted symlinks to be the length of the decrypted * symlink target (or the no-key encoded symlink target, if the key is