binder: Fix missing kernel-doc entries in binder.c

[PATCH v2] binder: Fix missing kernel-doc entries in binder.c

Posted by Kriish Sharma 2 months, 2 weeks ago

Fix several kernel-doc warnings in `drivers/android/binder.c` caused by
undocumented struct members and function parameters.

In particular, add missing documentation for the `@thread` parameter in
binder_free_buf_locked().

Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---
v2:
  - Align `@thread` with other parameters
  - Move `@thread` after `@proc`
  - Update commit subject to "binder:"

v1: https://lore.kernel.org/all/20250925025517.815391-1-kriish.sharma2006@gmail.com/


 drivers/android/binder.c | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/drivers/android/binder.c b/drivers/android/binder.c
index 312b462e349d..d25b79a3d502 100644
--- a/drivers/android/binder.c
+++ b/drivers/android/binder.c
@@ -2417,10 +2417,10 @@ static int binder_translate_fd(u32 fd, binder_size_t fd_offset,
 
 /**
  * struct binder_ptr_fixup - data to be fixed-up in target buffer
- * @offset	offset in target buffer to fixup
- * @skip_size	bytes to skip in copy (fixup will be written later)
- * @fixup_data	data to write at fixup offset
- * @node	list node
+ * @offset:      offset in target buffer to fixup
+ * @skip_size:   bytes to skip in copy (fixup will be written later)
+ * @fixup_data:  data to write at fixup offset
+ * @node:        list node
  *
  * This is used for the pointer fixup list (pf) which is created and consumed
  * during binder_transaction() and is only accessed locally. No
@@ -2437,10 +2437,10 @@ struct binder_ptr_fixup {
 
 /**
  * struct binder_sg_copy - scatter-gather data to be copied
- * @offset		offset in target buffer
- * @sender_uaddr	user address in source buffer
- * @length		bytes to copy
- * @node		list node
+ * @offset:        offset in target buffer
+ * @sender_uaddr:  user address in source buffer
+ * @length:        bytes to copy
+ * @node:          list node
  *
  * This is used for the sg copy list (sgc) which is created and consumed
  * during binder_transaction() and is only accessed locally. No
@@ -3994,14 +3994,15 @@ binder_freeze_notification_done(struct binder_proc *proc,
 
 /**
  * binder_free_buf() - free the specified buffer
- * @proc:	binder proc that owns buffer
- * @buffer:	buffer to be freed
- * @is_failure:	failed to send transaction
+ * @proc:       binder proc that owns buffer
+ * @thread:     binder thread performing the buffer release
+ * @buffer:     buffer to be freed
+ * @is_failure: failed to send transaction
  *
- * If buffer for an async transaction, enqueue the next async
+ * If the buffer is for an async transaction, enqueue the next async
  * transaction from the node.
  *
- * Cleanup buffer and free it.
+ * Cleanup the buffer and free it.
  */
 static void
 binder_free_buf(struct binder_proc *proc,
-- 
2.34.1

Re: [PATCH v2] binder: Fix missing kernel-doc entries in binder.c

Posted by Carlos Llamas 2 months, 2 weeks ago

On Fri, Oct 03, 2025 at 06:08:49PM +0000, Kriish Sharma wrote:
> Fix several kernel-doc warnings in `drivers/android/binder.c` caused by
> undocumented struct members and function parameters.
> 
> In particular, add missing documentation for the `@thread` parameter in
> binder_free_buf_locked().
> 
> Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
> ---
> v2:
>   - Align `@thread` with other parameters
>   - Move `@thread` after `@proc`
>   - Update commit subject to "binder:"
> 
> v1: https://lore.kernel.org/all/20250925025517.815391-1-kriish.sharma2006@gmail.com/
> 
> 
>  drivers/android/binder.c | 27 ++++++++++++++-------------
>  1 file changed, 14 insertions(+), 13 deletions(-)
> 
> diff --git a/drivers/android/binder.c b/drivers/android/binder.c
> index 312b462e349d..d25b79a3d502 100644
> --- a/drivers/android/binder.c
> +++ b/drivers/android/binder.c
> @@ -2417,10 +2417,10 @@ static int binder_translate_fd(u32 fd, binder_size_t fd_offset,
>  
>  /**
>   * struct binder_ptr_fixup - data to be fixed-up in target buffer
> - * @offset	offset in target buffer to fixup
> - * @skip_size	bytes to skip in copy (fixup will be written later)
> - * @fixup_data	data to write at fixup offset
> - * @node	list node
> + * @offset:      offset in target buffer to fixup
> + * @skip_size:   bytes to skip in copy (fixup will be written later)
> + * @fixup_data:  data to write at fixup offset
> + * @node:        list node
>   *
>   * This is used for the pointer fixup list (pf) which is created and consumed
>   * during binder_transaction() and is only accessed locally. No
> @@ -2437,10 +2437,10 @@ struct binder_ptr_fixup {
>  
>  /**
>   * struct binder_sg_copy - scatter-gather data to be copied
> - * @offset		offset in target buffer
> - * @sender_uaddr	user address in source buffer
> - * @length		bytes to copy
> - * @node		list node
> + * @offset:        offset in target buffer
> + * @sender_uaddr:  user address in source buffer
> + * @length:        bytes to copy
> + * @node:          list node
>   *
>   * This is used for the sg copy list (sgc) which is created and consumed
>   * during binder_transaction() and is only accessed locally. No
> @@ -3994,14 +3994,15 @@ binder_freeze_notification_done(struct binder_proc *proc,
>  
>  /**
>   * binder_free_buf() - free the specified buffer
> - * @proc:	binder proc that owns buffer
> - * @buffer:	buffer to be freed
> - * @is_failure:	failed to send transaction
> + * @proc:       binder proc that owns buffer
> + * @thread:     binder thread performing the buffer release
> + * @buffer:     buffer to be freed
> + * @is_failure: failed to send transaction
>   *
> - * If buffer for an async transaction, enqueue the next async
> + * If the buffer is for an async transaction, enqueue the next async
>   * transaction from the node.
>   *
> - * Cleanup buffer and free it.
> + * Cleanup the buffer and free it.
>   */
>  static void
>  binder_free_buf(struct binder_proc *proc,
> -- 
> 2.34.1
> 

Thanks,

Acked-by: Carlos Llamas <cmllamas@google.com>