* [PATCH] fscache: fix misdocumented parameter name
@ 2022-05-21 14:24 ` Khalid Masum
0 siblings, 0 replies; 4+ messages in thread
From: Khalid Masum @ 2022-05-21 14:24 UTC (permalink / raw)
To: linux-kernel-mentees
Cc: Shuah Khan, David Howells, linux-cachefs, linux-kernel, Khalid Masum
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>
---
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)
*
--
2.25.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH] fscache: fix misdocumented parameter name
@ 2022-05-21 14:24 ` Khalid Masum
0 siblings, 0 replies; 4+ messages in thread
From: Khalid Masum @ 2022-05-21 14:24 UTC (permalink / raw)
To: linux-kernel-mentees; +Cc: David Howells, linux-cachefs, linux-kernel
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>
---
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)
*
--
2.25.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] fscache: fix misdocumented parameter name
2022-05-21 14:24 ` Khalid Masum
@ 2022-05-21 15:31 ` Randy Dunlap
-1 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2022-05-21 15:31 UTC (permalink / raw)
To: Khalid Masum, linux-kernel-mentees
Cc: Shuah Khan, David Howells, linux-cachefs, linux-kernel
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] fscache: fix misdocumented parameter name
@ 2022-05-21 15:31 ` Randy Dunlap
0 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2022-05-21 15:31 UTC (permalink / raw)
To: Khalid Masum, linux-kernel-mentees
Cc: David Howells, linux-cachefs, linux-kernel
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
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-05-21 15:32 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-05-21 14:24 [PATCH] fscache: fix misdocumented parameter name Khalid Masum
2022-05-21 14:24 ` Khalid Masum
2022-05-21 15:31 ` Randy Dunlap
2022-05-21 15:31 ` Randy Dunlap
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.