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] [day] [month] [year] [list]

Message-ID: <Zj4t4zOjMlW3o57c@smile.fi.intel.com>
Date: Fri, 10 May 2024 17:23:31 +0300
From: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
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 Fri, May 10, 2024 at 10:34:05AM +0100, Greg Kroah-Hartman wrote:
> 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.

..

> >  /**
> >   * 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 :(

Yeah, it slips over my fingers, sorry. I will try again.

-- 
With Best Regards,
Andy Shevchenko