From: Julia Lawall <julia.lawall@lip6.fr>
To: Tamara Diaconita <diaconitatamara@gmail.com>
Cc: lgirdwood@gmail.com, broonie@kernel.org,
linux-kernel@vger.kernel.org, outreachy-kernel@googlegroups.com,
corbet@lwn.net, Tamara Diaconita <diaconita.tamara@gmail.com>
Subject: Re: [Outreachy kernel] [PATCH] Regulator: core.c: Fix kerneldoc comments
Date: Tue, 28 Mar 2017 21:51:15 +0200 (CEST) [thread overview]
Message-ID: <alpine.DEB.2.20.1703282149260.2345@hadrien> (raw)
In-Reply-To: <20170328183021.2683-1-diaconita.tamara@gmail.com>
On Tue, 28 Mar 2017, Tamara Diaconita wrote:
> Remove the description for the non-existing 'ret' to fix the build warning:
> ./drivers/regulator/core.c:1467: warning:
> Excess function parameter 'ret' description in 'regulator_dev_lookup'.
> The description found for the return value is: @ret: 0 on success, -ENODEV
> if lookup fails permanently, -EPROBE_DEFER if lookup could succeed in the future.
Fine for this patch, but if you are finding more of these, I don't think
you need to quote the removed text in the commit log. One can see it just
below in the patch. Actually,
"Remove the description for the non-existent parameter ret. Problem
detected using the kerneldoc build."
seems like it would be sufficient.
julia
>
>
> Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com>
> ---
> drivers/regulator/core.c | 2 --
> 1 file changed, 2 deletions(-)
>
> diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
> index 53d4fc7..219b665 100644
> --- a/drivers/regulator/core.c
> +++ b/drivers/regulator/core.c
> @@ -1451,8 +1451,6 @@ static struct regulator_dev *regulator_lookup_by_name(const char *name)
> * regulator_dev_lookup - lookup a regulator device.
> * @dev: device for regulator "consumer".
> * @supply: Supply name or regulator ID.
> - * @ret: 0 on success, -ENODEV if lookup fails permanently, -EPROBE_DEFER if
> - * lookup could succeed in the future.
> *
> * If successful, returns a struct regulator_dev that corresponds to the name
> * @supply and with the embedded struct device refcount incremented by one.
> --
> 2.9.3
>
> --
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To post to this group, send email to outreachy-kernel@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20170328183021.2683-1-diaconita.tamara%40gmail.com.
> For more options, visit https://groups.google.com/d/optout.
>
next prev parent reply other threads:[~2017-03-28 19:51 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-28 18:30 [PATCH] Regulator: core.c: Fix kerneldoc comments Tamara Diaconita
2017-03-28 19:51 ` Julia Lawall [this message]
2017-03-29 10:36 ` Mark Brown
2017-03-29 11:02 ` Applied "regulator: core: Fix kerneldoc comments" to the regulator tree Mark Brown
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=alpine.DEB.2.20.1703282149260.2345@hadrien \
--to=julia.lawall@lip6.fr \
--cc=broonie@kernel.org \
--cc=corbet@lwn.net \
--cc=diaconita.tamara@gmail.com \
--cc=diaconitatamara@gmail.com \
--cc=lgirdwood@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=outreachy-kernel@googlegroups.com \
/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;
as well as URLs for NNTP newsgroup(s).