[PATCH] hv: fix missing kernel-doc description for 'size' in request_arr_init()

kriish.sharma2006@gmail.com posted 1 patch 3 months, 2 weeks ago
drivers/hv/channel.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] hv: fix missing kernel-doc description for 'size' in request_arr_init()
Posted by kriish.sharma2006@gmail.com 3 months, 2 weeks ago
From: Kriish Sharma <kriish.sharma2006@gmail.com>

Add missing kernel-doc entry for the @size parameter in
request_arr_init(), fixing the following documentation warning
reported by the kernel test robot and detected via kernel-doc:

Warning: drivers/hv/channel.c:595 function parameter 'size' not described in 'request_arr_init'

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202503021934.wH1BERla-lkp@intel.com
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---
 drivers/hv/channel.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/hv/channel.c b/drivers/hv/channel.c
index 88485d255a42..6821f225248b 100644
--- a/drivers/hv/channel.c
+++ b/drivers/hv/channel.c
@@ -590,7 +590,7 @@ EXPORT_SYMBOL_GPL(vmbus_establish_gpadl);
  * keeps track of the next available slot in the array. Initially, each
  * slot points to the next one (as in a Linked List). The last slot
  * does not point to anything, so its value is U64_MAX by default.
- * @size The size of the array
+ * @size: The size of the array
  */
 static u64 *request_arr_init(u32 size)
 {
-- 
2.34.1
Re: [PATCH] hv: fix missing kernel-doc description for 'size' in request_arr_init()
Posted by Wei Liu 3 months, 1 week ago
On Sat, Oct 25, 2025 at 12:07:07PM +0000, kriish.sharma2006@gmail.com wrote:
> From: Kriish Sharma <kriish.sharma2006@gmail.com>
> 
> Add missing kernel-doc entry for the @size parameter in
> request_arr_init(), fixing the following documentation warning
> reported by the kernel test robot and detected via kernel-doc:
> 
> Warning: drivers/hv/channel.c:595 function parameter 'size' not described in 'request_arr_init'
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202503021934.wH1BERla-lkp@intel.com
> Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>

Applied to hyperv-next.

I changed the subject line to match the existing pattern.

> ---
>  drivers/hv/channel.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/hv/channel.c b/drivers/hv/channel.c
> index 88485d255a42..6821f225248b 100644
> --- a/drivers/hv/channel.c
> +++ b/drivers/hv/channel.c
> @@ -590,7 +590,7 @@ EXPORT_SYMBOL_GPL(vmbus_establish_gpadl);
>   * keeps track of the next available slot in the array. Initially, each
>   * slot points to the next one (as in a Linked List). The last slot
>   * does not point to anything, so its value is U64_MAX by default.
> - * @size The size of the array
> + * @size: The size of the array
>   */
>  static u64 *request_arr_init(u32 size)
>  {
> -- 
> 2.34.1
>
Re: [PATCH] hv: fix missing kernel-doc description for 'size' in request_arr_init()
Posted by Easwar Hariharan 3 months, 1 week ago
On 10/25/2025 5:07 AM, kriish.sharma2006@gmail.com wrote:
> From: Kriish Sharma <kriish.sharma2006@gmail.com>
> 
> Add missing kernel-doc entry for the @size parameter in
> request_arr_init(), fixing the following documentation warning
> reported by the kernel test robot and detected via kernel-doc:
> 
> Warning: drivers/hv/channel.c:595 function parameter 'size' not described in 'request_arr_init'
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202503021934.wH1BERla-lkp@intel.com
> Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
> ---
>  drivers/hv/channel.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 

Thanks for the patch!

Reviewed-by: Easwar Hariharan <easwar.hariharan@linux.microsoft.com>

> diff --git a/drivers/hv/channel.c b/drivers/hv/channel.c
> index 88485d255a42..6821f225248b 100644
> --- a/drivers/hv/channel.c
> +++ b/drivers/hv/channel.c
> @@ -590,7 +590,7 @@ EXPORT_SYMBOL_GPL(vmbus_establish_gpadl);
>   * keeps track of the next available slot in the array. Initially, each
>   * slot points to the next one (as in a Linked List). The last slot
>   * does not point to anything, so its value is U64_MAX by default.
> - * @size The size of the array
> + * @size: The size of the array
>   */
>  static u64 *request_arr_init(u32 size)
>  {