From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932336AbdC1Tvo (ORCPT ); Tue, 28 Mar 2017 15:51:44 -0400 Received: from mail3-relais-sop.national.inria.fr ([192.134.164.104]:23357 "EHLO mail3-relais-sop.national.inria.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932160AbdC1Tvm (ORCPT ); Tue, 28 Mar 2017 15:51:42 -0400 X-IronPort-AV: E=Sophos;i="5.36,238,1486422000"; d="scan'208";a="218392092" Date: Tue, 28 Mar 2017 21:51:15 +0200 (CEST) From: Julia Lawall X-X-Sender: jll@hadrien To: Tamara Diaconita cc: lgirdwood@gmail.com, broonie@kernel.org, linux-kernel@vger.kernel.org, outreachy-kernel@googlegroups.com, corbet@lwn.net, Tamara Diaconita Subject: Re: [Outreachy kernel] [PATCH] Regulator: core.c: Fix kerneldoc comments In-Reply-To: <20170328183021.2683-1-diaconita.tamara@gmail.com> Message-ID: References: <20170328183021.2683-1-diaconita.tamara@gmail.com> User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > --- > 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. >