linux-kernel - Re: [PATCH] most: fix kernel-doc warnings

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: <Y8lsvtoSYFj/8/U/@kroah.com>
Date:   Thu, 19 Jan 2023 17:15:58 +0100
From:   Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        Christian Gromm <christian.gromm@...rochip.com>
Subject: Re: [PATCH] most: fix kernel-doc warnings

On Thu, Jan 12, 2023 at 10:39:47PM -0800, Randy Dunlap wrote:
> Fix various W=1 kernel-doc warnings in drivers/most/:
> 
> drivers/most/most_usb.c:669: warning: Excess function parameter 'data' description in 'link_stat_timer_handler'
> drivers/most/most_usb.c:769: warning: cannot understand function prototype: 'const struct file_operations hdm_usb_fops = '
> drivers/most/most_usb.c:776: warning: cannot understand function prototype: 'const struct usb_device_id usbid[] = '
> drivers/most/most_cdev.c:301: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Initialization of struct file_operations
> drivers/most/most_cdev.c:414: warning: Function parameter or member 'args' not described in 'comp_probe'
> drivers/most/most_snd.c:56: warning: Function parameter or member 'pcm_hardware' not described in 'channel'
> drivers/most/most_snd.c:56: warning: Function parameter or member 'copy_fn' not described in 'channel'
> drivers/most/most_snd.c:404: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Initialization of struct snd_pcm_ops
> drivers/most/most_snd.c:514: warning: Function parameter or member 'device_name' not described in 'audio_probe_channel'
> drivers/most/most_snd.c:703: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Initialization of the struct most_component
> 
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Christian Gromm <christian.gromm@...rochip.com>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> ---
> Also: what does MOST mean? Can that be added to drivers/most/Kconfig,
>     in a prompt or help text?
> Also: how about a MAINTAINERS entry for drivers/most/?

That would be good, Christian, can you send a patch for that?

thanks,

greg k-h