From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-11.6 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_2 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3D4F9C433E5 for ; Sat, 18 Jul 2020 14:39:17 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 1CDAC2080D for ; Sat, 18 Jul 2020 14:39:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595083157; bh=BnlatMn5uJqDSL7prgKupwRyysyX9jNEbeM2XXw8yYc=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=XxusIHuQNoAHNfmW/3FuIG9ksJdyUlryb1uTqsD+R2+cML9HUwjonge9qMgCPMOKZ Wsvk8656NyeeZdcjzwZGFsU4qoa8nMAfOR8KORdOwdoLW5TFjjZWFatxTQxkueBVDr wBhKqS/KT82hrhEcvNYyqrjMFnT+0uB6doBLDQLY= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728009AbgGROjP (ORCPT ); Sat, 18 Jul 2020 10:39:15 -0400 Received: from mail.kernel.org ([198.145.29.99]:60002 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727819AbgGROjP (ORCPT ); Sat, 18 Jul 2020 10:39:15 -0400 Received: from archlinux (cpc149474-cmbg20-2-0-cust94.5-4.cable.virginm.net [82.4.196.95]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 6BE5220684; Sat, 18 Jul 2020 14:39:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595083154; bh=BnlatMn5uJqDSL7prgKupwRyysyX9jNEbeM2XXw8yYc=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=ioEZ5jbR/U0zAmI+t1CmUie4Ch9ux5SZrWigH+ehVvJNABPrVuqAExPTkJ2BHt7OM KoMeCg+EK1wQJ27z/Dv0X2E0IN10S8aH1XgquPBrDEprxr0R3nkoBfo0HM0CwTv35u E8TXW+Q30AZ56DenzcjGwiXua7ZSHjN2WXa9pfCE= Date: Sat, 18 Jul 2020 15:39:10 +0100 From: Jonathan Cameron To: Lee Jones Cc: knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org Subject: Re: [PATCH 09/30] iio: dummy: iio_simple_dummy: Demote unworthy kerneldocs and correct misspelling Message-ID: <20200718153910.71fcdb36@archlinux> In-Reply-To: <20200716135928.1456727-10-lee.jones@linaro.org> References: <20200716135928.1456727-1-lee.jones@linaro.org> <20200716135928.1456727-10-lee.jones@linaro.org> X-Mailer: Claws Mail 3.17.5 (GTK+ 2.24.32; x86_64-pc-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, 16 Jul 2020 14:59:07 +0100 Lee Jones wrote: > File header comments are not good candidates for kerneldoc. Neither > are generic comment blocks. > > Fixes the following W=1 kernel build warning(s): > > drivers/iio/dummy/iio_simple_dummy.c:26: warning: cannot understand function prototype: 'const struct config_item_type iio_dummy_type = ' > drivers/iio/dummy/iio_simple_dummy.c:564: warning: Function parameter or member 'name' not described in 'iio_dummy_probe' > drivers/iio/dummy/iio_simple_dummy.c:564: warning: Excess function parameter 'index' description in 'iio_dummy_probe' > drivers/iio/dummy/iio_simple_dummy.c:700: warning: cannot understand function prototype: 'const struct iio_sw_device_ops iio_dummy_device_ops = ' > Misspelling is an interesting way of describing that part. I changed it to "wrong parameter in docs". Applied. > Signed-off-by: Lee Jones > --- > drivers/iio/dummy/iio_simple_dummy.c | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/drivers/iio/dummy/iio_simple_dummy.c b/drivers/iio/dummy/iio_simple_dummy.c > index 6cb02299a2152..be66b26373723 100644 > --- a/drivers/iio/dummy/iio_simple_dummy.c > +++ b/drivers/iio/dummy/iio_simple_dummy.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * Copyright (c) 2011 Jonathan Cameron > * > * A reference industrial I/O driver to illustrate the functionality available. > @@ -553,7 +553,7 @@ static int iio_dummy_init_device(struct iio_dev *indio_dev) > > /** > * iio_dummy_probe() - device instance probe > - * @index: an id number for this instance. > + * @name: name of this instance. > * > * Arguments are bus type specific. > * I2C: iio_dummy_probe(struct i2c_client *client, > @@ -687,7 +687,7 @@ static int iio_dummy_remove(struct iio_sw_device *swd) > > return 0; > } > -/** > +/* > * module_iio_sw_device_driver() - device driver registration > * > * Varies depending on bus type of the device. As there is no device From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-11.5 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_2 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BBC4FC433E1 for ; Sat, 18 Jul 2020 14:40:41 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 8898B2064B for ; Sat, 18 Jul 2020 14:40:41 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="JSXmqH5/"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="ioEZ5jbR" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 8898B2064B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-ID: Subject:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=NlQ/rrVMW52SxHuTtsaLWm1+GjihSVv6ImZIIaw7R5Q=; b=JSXmqH5/D8xuJC49R4Z//PcW5 hDXwrJujv4JCrpuInjSnddzivUdU3RPJUY2VAm0qW2bnJgfGupHDdAfUdqzctZUDqdtSUTZ3GkAhF sVJSIUBGD2zzzQQIjCzWn414zyxWzCbsz5cvqXHivepux6jORLfDMZgzgMPzg91nh03GlVrOEFat7 7fglYOoN4Jqt8WQEnB947+70l1sotRg0QlMtVbwyVd0+sS1EIGbrTGHvyQra+xUdLNAapVHFhnbLz to691C/SzxZWWQGPt7ZiKW+WVP84ubHB+LXmcwwNZpDDFB+lJiP9eZoANIPRgDLsF8j9fhMLEGSbr wQG0vXnzA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jwnzh-0003cO-Fp; Sat, 18 Jul 2020 14:39:17 +0000 Received: from mail.kernel.org ([198.145.29.99]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jwnzf-0003bm-6L for linux-arm-kernel@lists.infradead.org; Sat, 18 Jul 2020 14:39:16 +0000 Received: from archlinux (cpc149474-cmbg20-2-0-cust94.5-4.cable.virginm.net [82.4.196.95]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 6BE5220684; Sat, 18 Jul 2020 14:39:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595083154; bh=BnlatMn5uJqDSL7prgKupwRyysyX9jNEbeM2XXw8yYc=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=ioEZ5jbR/U0zAmI+t1CmUie4Ch9ux5SZrWigH+ehVvJNABPrVuqAExPTkJ2BHt7OM KoMeCg+EK1wQJ27z/Dv0X2E0IN10S8aH1XgquPBrDEprxr0R3nkoBfo0HM0CwTv35u E8TXW+Q30AZ56DenzcjGwiXua7ZSHjN2WXa9pfCE= Date: Sat, 18 Jul 2020 15:39:10 +0100 From: Jonathan Cameron To: Lee Jones Subject: Re: [PATCH 09/30] iio: dummy: iio_simple_dummy: Demote unworthy kerneldocs and correct misspelling Message-ID: <20200718153910.71fcdb36@archlinux> In-Reply-To: <20200716135928.1456727-10-lee.jones@linaro.org> References: <20200716135928.1456727-1-lee.jones@linaro.org> <20200716135928.1456727-10-lee.jones@linaro.org> X-Mailer: Claws Mail 3.17.5 (GTK+ 2.24.32; x86_64-pc-linux-gnu) MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200718_103916_021442_5EA2C83B X-CRM114-Status: GOOD ( 17.63 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: lars@metafoo.de, linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, pmeerw@pmeerw.net, knaack.h@gmx.de, linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Thu, 16 Jul 2020 14:59:07 +0100 Lee Jones wrote: > File header comments are not good candidates for kerneldoc. Neither > are generic comment blocks. > > Fixes the following W=1 kernel build warning(s): > > drivers/iio/dummy/iio_simple_dummy.c:26: warning: cannot understand function prototype: 'const struct config_item_type iio_dummy_type = ' > drivers/iio/dummy/iio_simple_dummy.c:564: warning: Function parameter or member 'name' not described in 'iio_dummy_probe' > drivers/iio/dummy/iio_simple_dummy.c:564: warning: Excess function parameter 'index' description in 'iio_dummy_probe' > drivers/iio/dummy/iio_simple_dummy.c:700: warning: cannot understand function prototype: 'const struct iio_sw_device_ops iio_dummy_device_ops = ' > Misspelling is an interesting way of describing that part. I changed it to "wrong parameter in docs". Applied. > Signed-off-by: Lee Jones > --- > drivers/iio/dummy/iio_simple_dummy.c | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/drivers/iio/dummy/iio_simple_dummy.c b/drivers/iio/dummy/iio_simple_dummy.c > index 6cb02299a2152..be66b26373723 100644 > --- a/drivers/iio/dummy/iio_simple_dummy.c > +++ b/drivers/iio/dummy/iio_simple_dummy.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * Copyright (c) 2011 Jonathan Cameron > * > * A reference industrial I/O driver to illustrate the functionality available. > @@ -553,7 +553,7 @@ static int iio_dummy_init_device(struct iio_dev *indio_dev) > > /** > * iio_dummy_probe() - device instance probe > - * @index: an id number for this instance. > + * @name: name of this instance. > * > * Arguments are bus type specific. > * I2C: iio_dummy_probe(struct i2c_client *client, > @@ -687,7 +687,7 @@ static int iio_dummy_remove(struct iio_sw_device *swd) > > return 0; > } > -/** > +/* > * module_iio_sw_device_driver() - device driver registration > * > * Varies depending on bus type of the device. As there is no device _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel