On 8/18/22 12:07 PM, Khalid Masum wrote:
> This patch fixes two warnings generated by make docs. The functions
> fscache_use_cookie and fscache_unuse_cookie, both have a parameter
> named cookie. But they are documented with the name "object" with
> unclear description. Which generates the warning when creating docs.
>
> This commit will replace the currently misdocumented parameter names
> with the correct ones while adding proper descriptions.
>
> CC: Randy Dunlap <rdun...@infradead.org>
> Signed-off-by: Khalid Masum <khalid.masum...@gmail.com>
LGTM.
Reviewed-by: Jingbo Xu <jeffl...@linux.alibaba.com>
> ---
> Changes since v1:
> - Update commit message.
> - Link:
> https://lore.kernel.org/lkml/20220521142446.4746-1-khalid.masum...@gmail.com/
>
> 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 720874e6ee94..36e5dd84cf59 100644
> --- a/include/linux/fscache.h
> +++ b/include/linux/fscache.h
> @@ -258,7 +258,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
> @@ -274,7 +274,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)
> *
--
Thanks,
Jingbo
--
Linux-cachefs mailing list
Linux-cachefs@redhat.com
https://listman.redhat.com/mailman/listinfo/linux-cachefs
