linux-kernel - Re: [Outreachy kernel] [PATCH] Regulator: core.c: Fix kerneldoc comments

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: <alpine.DEB.2.20.1703282149260.2345@hadrien>
Date:   Tue, 28 Mar 2017 21:51:15 +0200 (CEST)
From:   Julia Lawall <julia.lawall@...6.fr>
To:     Tamara Diaconita <diaconitatamara@...il.com>
cc:     lgirdwood@...il.com, broonie@...nel.org,
        linux-kernel@...r.kernel.org, outreachy-kernel@...glegroups.com,
        corbet@....net, Tamara Diaconita <diaconita.tamara@...il.com>
Subject: Re: [Outreachy kernel] [PATCH] Regulator: core.c: Fix kerneldoc
 comments



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@...il.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@...glegroups.com.
> To post to this group, send email to outreachy-kernel@...glegroups.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.
>