* [PATCH 1/2] android: binderfs: add missing parameters in binder_ctl_ioctl()'s doc [not found] <20251121111203.21800-1-adelodunolaoluwa.ref@yahoo.com> @ 2025-11-21 11:12 ` 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:09 ` [PATCH 1/2] android: binderfs: add missing parameters in binder_ctl_ioctl()'s doc Carlos Llamas 0 siblings, 2 replies; 5+ messages in thread From: Sunday Adelodun @ 2025-11-21 11:12 UTC (permalink / raw) To: Greg Kroah-Hartman, Arve, Todd Kjos, Martijn Coenen, Joel Fernandes, Christian Brauner, Carlos Llamas, Suren Baghdasaryan Cc: linux-kernel, skhan, david.hunter.linux, linux-kernel-mentees, Sunday Adelodun, kernel test robot The kernel-doc comment for binder_ctl_ioctl() lacks descriptions for the @file, @cmd, and @arg parameters, which triggers warnings during documentation builds. 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/ 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. * * The request handler for the binder-control device. All requests operate on * the binderfs mount the binder-control device resides in: -- 2.43.0 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 2/2] android: binder: add missing return value documentation for binder_apply_fd_fixups() 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 ` Sunday Adelodun 2025-12-02 17:11 ` Carlos Llamas 2025-12-02 17:09 ` [PATCH 1/2] android: binderfs: add missing parameters in binder_ctl_ioctl()'s doc Carlos Llamas 1 sibling, 1 reply; 5+ messages in thread From: Sunday Adelodun @ 2025-11-21 11:12 UTC (permalink / raw) To: Greg Kroah-Hartman, Arve, Todd Kjos, Martijn Coenen, Joel Fernandes, Christian Brauner, Carlos Llamas, Suren Baghdasaryan Cc: linux-kernel, skhan, david.hunter.linux, linux-kernel-mentees, Sunday Adelodun The kernel-doc for binder_apply_fd_fixups() was missing a description of its return value, which triggers a kernel-doc warning. Add the missing "Return:" entry to doc that the function returns 0 on success or a negative errno on failure. Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com> --- drivers/android/binder.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/drivers/android/binder.c b/drivers/android/binder.c index a3a1b5c33ba3..535fc881c8da 100644 --- a/drivers/android/binder.c +++ b/drivers/android/binder.c @@ -4669,6 +4669,8 @@ static int binder_wait_for_work(struct binder_thread *thread, * * If we fail to allocate an fd, skip the install and release * any fds that have already been allocated. + * + * Return: 0 on success, a negative errno code on failure. */ static int binder_apply_fd_fixups(struct binder_proc *proc, struct binder_transaction *t) -- 2.43.0 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 2/2] android: binder: add missing return value documentation for binder_apply_fd_fixups() 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 0 siblings, 1 reply; 5+ messages in thread From: Carlos Llamas @ 2025-12-02 17:11 UTC (permalink / raw) To: Sunday Adelodun Cc: Greg Kroah-Hartman, Arve, Todd Kjos, Martijn Coenen, Joel Fernandes, Christian Brauner, Suren Baghdasaryan, linux-kernel, skhan, david.hunter.linux, linux-kernel-mentees On Fri, Nov 21, 2025 at 12:12:03PM +0100, Sunday Adelodun wrote: > The kernel-doc for binder_apply_fd_fixups() was missing a description of > its return value, which triggers a kernel-doc warning. How does one trigger this warning? Was there a report of this? Can you add the warning you see to the commit message? > > Add the missing "Return:" entry to doc that the function returns 0 on > success or a negative errno on failure. > > Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com> > --- > drivers/android/binder.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/drivers/android/binder.c b/drivers/android/binder.c > index a3a1b5c33ba3..535fc881c8da 100644 > --- a/drivers/android/binder.c > +++ b/drivers/android/binder.c > @@ -4669,6 +4669,8 @@ static int binder_wait_for_work(struct binder_thread *thread, > * > * If we fail to allocate an fd, skip the install and release > * any fds that have already been allocated. > + * > + * Return: 0 on success, a negative errno code on failure. > */ > static int binder_apply_fd_fixups(struct binder_proc *proc, > struct binder_transaction *t) > -- > 2.43.0 > Thanks, Carlos Llamas ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 2/2] android: binder: add missing return value documentation for binder_apply_fd_fixups() 2025-12-02 17:11 ` Carlos Llamas @ 2025-12-04 0:46 ` Carlos Llamas 0 siblings, 0 replies; 5+ messages in thread From: Carlos Llamas @ 2025-12-04 0:46 UTC (permalink / raw) To: Sunday Adelodun Cc: Greg Kroah-Hartman, Arve, Todd Kjos, Martijn Coenen, Joel Fernandes, Christian Brauner, Suren Baghdasaryan, linux-kernel, skhan, david.hunter.linux, linux-kernel-mentees On Tue, Dec 02, 2025 at 05:11:40PM +0000, Carlos Llamas wrote: > On Fri, Nov 21, 2025 at 12:12:03PM +0100, Sunday Adelodun wrote: > > The kernel-doc for binder_apply_fd_fixups() was missing a description of > > its return value, which triggers a kernel-doc warning. > > How does one trigger this warning? Was there a report of this? Can you > add the warning you see to the commit message? Ha! I guess one needs to ask for this warn: $ ./scripts/kernel-doc -Wreturn drivers/android/binder.c > /dev/null Warning: drivers/android/binder.c:4674 No description found for return value of 'binder_apply_fd_fixups' ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 1/2] android: binderfs: add missing parameters in binder_ctl_ioctl()'s doc 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:09 ` Carlos Llamas 1 sibling, 0 replies; 5+ messages in thread From: Carlos Llamas @ 2025-12-02 17:09 UTC (permalink / raw) To: Sunday Adelodun Cc: Greg Kroah-Hartman, Arve, Todd Kjos, Martijn Coenen, Joel Fernandes, Christian Brauner, Suren Baghdasaryan, linux-kernel, skhan, david.hunter.linux, linux-kernel-mentees, kernel test robot 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 ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2025-12-04 0:47 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[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 ` [PATCH 1/2] android: binderfs: add missing parameters in binder_ctl_ioctl()'s doc Carlos Llamas
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).