public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
From: Carlos Llamas <cmllamas@google.com>
To: Sunday Adelodun <adelodunolaoluwa@yahoo.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Arve <arve@android.com>, Todd Kjos <tkjos@android.com>,
	Martijn Coenen <maco@android.com>,
	Joel Fernandes <joelagnelf@nvidia.com>,
	Christian Brauner <brauner@kernel.org>,
	Suren Baghdasaryan <surenb@google.com>,
	linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
	david.hunter.linux@gmail.com,
	linux-kernel-mentees@lists.linuxfoundation.org,
	kernel test robot <lkp@intel.com>
Subject: Re: [PATCH 1/2] android: binderfs: add missing parameters in binder_ctl_ioctl()'s doc
Date: Tue, 2 Dec 2025 17:09:15 +0000	[thread overview]
Message-ID: <aS8dO9V4suAPF4QG@google.com> (raw)
In-Reply-To: <20251121111203.21800-1-adelodunolaoluwa@yahoo.com>

On Fri, Nov 21, 2025 at 12:12:02PM +0100, Sunday Adelodun wrote:
> The kernel-doc comment for binder_ctl_ioctl() lacks descriptions for the
> @file, @cmd, and @arg parameters, which triggers warnings during
> documentation builds.

Could you please add the warnings here?

> 
> Add the missing parameter descriptions to keep the
> kernel-doc consistent and free of warnings.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes:
> https://lore.kernel.org/oe-kbuild-all/202511201725.ni2HZ2PP-lkp@intel.com/

The link for the `Closes:` tag should be on the same line.

> Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com>
> ---
>  drivers/android/binderfs.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/android/binderfs.c b/drivers/android/binderfs.c
> index be8e64eb39ec..47f6d1e5971e 100644
> --- a/drivers/android/binderfs.c
> +++ b/drivers/android/binderfs.c
> @@ -224,6 +224,9 @@ static int binderfs_binder_device_create(struct inode *ref_inode,
>  
>  /**
>   * binder_ctl_ioctl - handle binder device node allocation requests
> + * @file: The file pointer for the binder-control device node.
> + * @cmd: The ioctl command.
> + * @arg: The ioctl argument.

Can you please follow other kernel-doc format in the file? e.g.
alignment, no period at the end, etc.

>   *
>   * The request handler for the binder-control device. All requests operate on
>   * the binderfs mount the binder-control device resides in:
> -- 
> 2.43.0
> 

This is the wrong file though. The reported issue was for the
drivers/android/binder/rust_binderfs.c file. Can you add the same
kernel-doc additions to both files in your next version?

Thanks,
Carlos Llamas

      parent reply	other threads:[~2025-12-02 17:09 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20251121111203.21800-1-adelodunolaoluwa.ref@yahoo.com>
2025-11-21 11:12 ` [PATCH 1/2] android: binderfs: add missing parameters in binder_ctl_ioctl()'s doc Sunday Adelodun
2025-11-21 11:12   ` [PATCH 2/2] android: binder: add missing return value documentation for binder_apply_fd_fixups() Sunday Adelodun
2025-12-02 17:11     ` Carlos Llamas
2025-12-04  0:46       ` Carlos Llamas
2025-12-02 17:09   ` 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=aS8dO9V4suAPF4QG@google.com \
    --to=cmllamas@google.com \
    --cc=adelodunolaoluwa@yahoo.com \
    --cc=arve@android.com \
    --cc=brauner@kernel.org \
    --cc=david.hunter.linux@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=joelagnelf@nvidia.com \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lkp@intel.com \
    --cc=maco@android.com \
    --cc=skhan@linuxfoundation.org \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox