linux-kernel - Re: [PATCH v1 1/1] usb: fotg210: Add missing kernel doc description

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]

Date: Fri, 10 May 2024 10:34:05 +0100
From: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc: Uwe Kleine-König <u.kleine-koenig@...gutronix.de>,
	linux-usb@...r.kernel.org, linux-kernel@...r.kernel.org,
	Linus Walleij <linus.walleij@...aro.org>
Subject: Re: [PATCH v1 1/1] usb: fotg210: Add missing kernel doc description

On Wed, May 08, 2024 at 06:03:35PM +0300, Andy Shevchenko wrote:
> kernel-doc validator is not happy:
> 
>   warning: Function parameter or struct member 'fotg' not described in 'fotg210_vbus'
> 
> Add missing description.
> 
> Fixes: 3e679bde529e ("usb: fotg210-udc: Implement VBUS session")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
> ---
>  drivers/usb/fotg210/fotg210-core.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/usb/fotg210/fotg210-core.c b/drivers/usb/fotg210/fotg210-core.c
> index 958fc40eae86..00483da40f04 100644
> --- a/drivers/usb/fotg210/fotg210-core.c
> +++ b/drivers/usb/fotg210/fotg210-core.c
> @@ -95,6 +95,7 @@ static int fotg210_gemini_init(struct fotg210 *fotg, struct resource *res,
>  
>  /**
>   * fotg210_vbus() - Called by gadget driver to enable/disable VBUS
> + * @fotg210: pointer to a private fotg210 object
>   * @enable: true to enable VBUS, false to disable VBUS
>   */
>  void fotg210_vbus(struct fotg210 *fotg, bool enable)

I don't think you actually built the documentation after this patch :(