From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: "Uwe Kleine-König" <u.kleine-koenig@pengutronix.de>,
linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org,
"Linus Walleij" <linus.walleij@linaro.org>
Subject: Re: [PATCH v1 1/1] usb: fotg210: Add missing kernel doc description
Date: Fri, 10 May 2024 10:34:05 +0100 [thread overview]
Message-ID: <2024051047-scrabble-variable-6e29@gregkh> (raw)
In-Reply-To: <20240508150335.1378629-1-andriy.shevchenko@linux.intel.com>
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@linux.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 :(
next prev parent reply other threads:[~2024-05-10 9:34 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-08 15:03 [PATCH v1 1/1] usb: fotg210: Add missing kernel doc description Andy Shevchenko
2024-05-09 14:58 ` kernel test robot
2024-05-10 9:34 ` Greg Kroah-Hartman [this message]
2024-05-10 14:23 ` Andy Shevchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2024051047-scrabble-variable-6e29@gregkh \
--to=gregkh@linuxfoundation.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=linus.walleij@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=u.kleine-koenig@pengutronix.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox