From: Carlos Llamas <cmllamas@google.com>
To: Kriish Sharma <kriish.sharma2006@gmail.com>
Cc: gregkh@linuxfoundation.org, arve@android.com, tkjos@android.com,
maco@android.com, joelagnelf@nvidia.com, brauner@kernel.org,
surenb@google.com, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] binder: Fix missing kernel-doc entries in binder.c
Date: Fri, 3 Oct 2025 18:23:30 +0000 [thread overview]
Message-ID: <aOAUovAmhN8QEAHd@google.com> (raw)
In-Reply-To: <20251003180849.1438872-1-kriish.sharma2006@gmail.com>
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>
prev parent reply other threads:[~2025-10-03 18:23 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-03 18:08 [PATCH v2] binder: Fix missing kernel-doc entries in binder.c Kriish Sharma
2025-10-03 18:23 ` Carlos Llamas [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aOAUovAmhN8QEAHd@google.com \
--to=cmllamas@google.com \
--cc=arve@android.com \
--cc=brauner@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=joelagnelf@nvidia.com \
--cc=kriish.sharma2006@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=maco@android.com \
--cc=surenb@google.com \
--cc=tkjos@android.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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.