On Thu, 05 Nov 2020, Lee Jones wrote: > On Thu, 05 Nov 2020, Jiri Slaby wrote: > > > On 04. 11. 20, 20:35, Lee Jones wrote: > > > - Functions must follow directly on from their headers > > > - Demote non-conforming kernel-doc header > > > - Ensure notes have unique section names > > > - Provide missing description for 'reinit' > > > > > > Fixes the following W=1 kernel build warning(s): > > > > > > drivers/tty/tty_ldisc.c:158: warning: cannot understand function > > > prototype: 'int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD); ' > > > drivers/tty/tty_ldisc.c:199: warning: Function parameter or member 'ld' > > > not described in 'tty_ldisc_put' > > > drivers/tty/tty_ldisc.c:260: warning: duplicate section name 'Note' > > > drivers/tty/tty_ldisc.c:717: warning: Function parameter or member > > > 'reinit' not described in 'tty_ldisc_hangup' > > > > > > Cc: Greg Kroah-Hartman <gre...@linuxfoundation.org> > > > Cc: Jiri Slaby <jirisl...@kernel.org> > > > Signed-off-by: Lee Jones <lee.jo...@linaro.org> > > > --- > > > drivers/tty/tty_ldisc.c | 10 +++++----- > > > 1 file changed, 5 insertions(+), 5 deletions(-) > > > > > > diff --git a/drivers/tty/tty_ldisc.c b/drivers/tty/tty_ldisc.c > > > index fe37ec331289b..aced2bf6173be 100644 > > > --- a/drivers/tty/tty_ldisc.c > > > +++ b/drivers/tty/tty_ldisc.c > > > @@ -190,7 +189,7 @@ static struct tty_ldisc *tty_ldisc_get(struct > > > tty_struct *tty, int disc) > > > return ld; > > > } > > > -/** > > > +/* > > > * tty_ldisc_put - release the ldisc > > > > Having tty_ldisc_get in kernel-doc, while tty_ldisc_put not doesn't make > > much sense. What's missing to tty_ldisc_put to conform to kernel-doc? > > Where are they in kernel-doc? I don't see any references.
Also: $ ./scripts/find-unused-docs.sh drivers/tty/ The following files contain kerneldoc comments for exported functions that are not used in the formatted documentation drivers/tty/n_tracesink.c drivers/tty/tty_baudrate.c drivers/tty/serial/8250/8250_port.c drivers/tty/serdev/core.c drivers/tty/vt/keyboard.c drivers/tty/vt/selection.c drivers/tty/vt/consolemap.c drivers/tty/vt/vt.c drivers/tty/tty_jobctrl.c drivers/tty/tty_buffer.c drivers/tty/n_tty.c drivers/tty/hvc/hvc_console.c drivers/tty/tty_ioctl.c drivers/tty/sysrq.c drivers/tty/tty_ldisc.c <--------- drivers/tty/tty_io.c drivers/tty/tty_port.c -- Lee Jones [李琼斯] Senior Technical Lead - Developer Services Linaro.org │ Open source software for Arm SoCs Follow Linaro: Facebook | Twitter | Blog
