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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <1636a540-2115-0cdc-aeb3-236fabd78ccb@infradead.org>
Date:   Mon, 5 Sep 2022 18:56:19 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Jiangshan Yi <13667453960@....com>,
        trond.myklebust@...merspace.com, anna@...nel.org
Cc:     linux-nfs@...r.kernel.org, linux-kernel@...r.kernel.org,
        Jiangshan Yi <yijiangshan@...inos.cn>,
        k2ci <kernel-bot@...inos.cn>
Subject: Re: [PATCH] fs/nfs/pnfs_nfs.c: fix spelling typo and syntax error in
 comment

Hi,

On 9/5/22 18:50, Jiangshan Yi wrote:
> From: Jiangshan Yi <yijiangshan@...inos.cn>
> 
> Fix spelling typo and syntax error in comment.
> 
> Reported-by: k2ci <kernel-bot@...inos.cn>
> Signed-off-by: Jiangshan Yi <yijiangshan@...inos.cn>
> ---
>  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