linux-kernel - Re: [PATCH] docs: android: Fix missing kernel-doc entries in binder.c

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <aOAAWZ5DsnbqPxIA@google.com>
Date: Fri, 3 Oct 2025 16:56:57 +0000
From: Carlos Llamas <cmllamas@...gle.com>
To: Kriish Sharma <kriish.sharma2006@...il.com>
Cc: gregkh@...uxfoundation.org, arve@...roid.com, tkjos@...roid.com,
	maco@...roid.com, joelagnelf@...dia.com, brauner@...nel.org,
	surenb@...gle.com, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: android: Fix missing kernel-doc entries in binder.c

On Thu, Sep 25, 2025 at 02:55:17AM +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 `@...ead` parameter in
> binder_free_buf_locked().
> 
> Signed-off-by: Kriish Sharma <kriish.sharma2006@...il.com>
> ---
>  drivers/android/binder.c | 17 +++++++++--------
>  1 file changed, 9 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/android/binder.c b/drivers/android/binder.c
> index 312b462e349d..d30d27bfc634 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
> @@ -3997,6 +3997,7 @@ binder_freeze_notification_done(struct binder_proc *proc,
>   * @proc:	binder proc that owns buffer
>   * @buffer:	buffer to be freed
>   * @is_failure:	failed to send transaction
> + * @thread: binder thread performing the buffer release

This is missing the alignment that other members have. Also, please keep
the same order of the arguments, so @thread should go after @proc.

>   *
>   * If buffer for an async transaction, enqueue the next async
>   * transaction from the node.
> -- 
> 2.34.1
> 

BTW, your subject is "docs: android:" which makes me think this is part
of Documentation/. Please just use "binder:" instead.

Thanks,
Carlos Llamas