linux-kernel - Re: [PATCH] fscache: fix misdocumented parameter name

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: <c02b4ae7-218e-2349-afcb-9ada25beb934@infradead.org>
Date:   Sat, 21 May 2022 08:31:54 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Khalid Masum <khalid.masum.92@...il.com>,
        linux-kernel-mentees@...ts.linuxfoundation.org
Cc:     Shuah Khan <skhan@...uxfoundation.org>,
        David Howells <dhowells@...hat.com>, linux-cachefs@...hat.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] fscache: fix misdocumented parameter name



On 5/21/22 07:24, Khalid Masum wrote:
> To fix warning generated by make docs in the file fscache.h:
> The functions fscache_use_cookie and fscache_unuse_cookie have a
> parameter named cookie. But they are documented with the name "object".
> Which generates warning when creating docs. This commit will replace
> the documentation with a better one named "cookie". This new
> documentation
> line is taken from the function fscache_update_cookie in the same
> file.
> 
> Signed-off-by: Khalid Masum <khalid.masum.92@...il.com>

LGTM. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

> ---
>  include/linux/fscache.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/fscache.h b/include/linux/fscache.h
> index e25539072..32cf593b8 100644
> --- a/include/linux/fscache.h
> +++ b/include/linux/fscache.h
> @@ -256,7 +256,7 @@ struct fscache_cookie *fscache_acquire_cookie(struct fscache_volume *volume,
>  
>  /**
>   * fscache_use_cookie - Request usage of cookie attached to an object
> - * @object: Object description
> + * @cookie: The cookie representing the cache object
>   * @will_modify: If cache is expected to be modified locally
>   *
>   * Request usage of the cookie attached to an object.  The caller should tell
> @@ -272,7 +272,7 @@ static inline void fscache_use_cookie(struct fscache_cookie *cookie,
>  
>  /**
>   * fscache_unuse_cookie - Cease usage of cookie attached to an object
> - * @object: Object description
> + * @cookie: The cookie representing the cache object
>   * @aux_data: Updated auxiliary data (or NULL)
>   * @object_size: Revised size of the object (or NULL)
>   *

-- 
~Randy