Re: [PATCH] fs/nfs/pnfs_nfs.c: fix spelling typo and syntax error in comment

From: Randy Dunlap
Date: Mon Sep 05 2022 - 21:56:39 EST


Hi,

On 9/5/22 18:50, Jiangshan Yi wrote:
> From: Jiangshan Yi <yijiangshan@xxxxxxxxxx>
>
> Fix spelling typo and syntax error in comment.
>
> Reported-by: k2ci <kernel-bot@xxxxxxxxxx>
> Signed-off-by: Jiangshan Yi <yijiangshan@xxxxxxxxxx>
> ---
> fs/nfs/pnfs_nfs.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/fs/nfs/pnfs_nfs.c b/fs/nfs/pnfs_nfs.c
> index 657c242a18ff..45a5a66a2e3e 100644
> --- a/fs/nfs/pnfs_nfs.c
> +++ b/fs/nfs/pnfs_nfs.c
> @@ -374,12 +374,12 @@ pnfs_bucket_search_commit_reqs(struct pnfs_commit_bucket *buckets,
> return NULL;
> }
>
> -/* pnfs_generic_search_commit_reqs - Search lists in @cinfo for the head reqest
> +/* pnfs_generic_search_commit_reqs - Search lists in @cinfo for the head request
> * for @page
> * @cinfo - commit info for current inode
> * @page - page to search for matching head request
> *

Since you are changing the Returns line anyway, please use the documented
kernel-doc syntax for it:

> - * Returns a the head request if one is found, otherwise returns NULL.
> + * Returns the head request if one is found, otherwise returns NULL.

* Return: the head request if one is found, otherwise %NULL.

> */
> struct nfs_page *
> pnfs_generic_search_commit_reqs(struct nfs_commit_info *cinfo, struct page *page)

Thanks.
--
~Randy