Messages in this thread | | | Date | Sat, 21 May 2022 08:31:54 -0700 | Subject | Re: [PATCH] fscache: fix misdocumented parameter name | From | Randy Dunlap <> |
| |
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@gmail.com>
LGTM. Thanks.
Reviewed-by: Randy Dunlap <rdunlap@infradead.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
| |