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 1444DC433DF for ; Sat, 18 Jul 2020 14:55:46 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id E60CA2070A for ; Sat, 18 Jul 2020 14:55:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595084145; bh=kjZhliArAupsgIQRojSt1mgRcPYN3aZHfo2EkpA7vg8=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=JHbdCETV3FljUO/fnj4HsYYMt+kfmcocbc7URGjiy5rYaK6mp5UGB3Obh8MR1YKt/ ZE4vJdTUTlJvG1ZedrO3G/6m/i0LetdgwJBP+fSeTxcjOC9/4rG8RLlxNJ1f7kkAd8 el7S7QoVNlV1BspMW/T+5SZ28NSgsvWuR6l989C8= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727938AbgGROzo (ORCPT ); Sat, 18 Jul 2020 10:55:44 -0400 Received: from mail.kernel.org ([198.145.29.99]:34398 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726574AbgGROzo (ORCPT ); Sat, 18 Jul 2020 10:55:44 -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 88D6220656; Sat, 18 Jul 2020 14:55:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595084143; bh=kjZhliArAupsgIQRojSt1mgRcPYN3aZHfo2EkpA7vg8=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=mYFSpyomkpTz4MVFl/SQ7vvPF/V54xzhpgc1ehuw3X3BY+Kr8Cz8mMK88/N0XesoP mgk069jE0kqOkmTlVgQ4p3eOZAGC6F9wdqHfLOUEn2+yyT+3Am7htoxWL7Hdi/444C o83OjwOBfSGHV0ah4NEIQNicRJTg565NQIVg/8Wo= Date: Sat, 18 Jul 2020 15:55:39 +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 13/30] iio: dummy: iio_simple_dummy_events: Demote file header and supply descriptions for val2 params Message-ID: <20200718155539.48913015@archlinux> In-Reply-To: <20200716135928.1456727-14-lee.jones@linaro.org> References: <20200716135928.1456727-1-lee.jones@linaro.org> <20200716135928.1456727-14-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:11 +0100 Lee Jones wrote: > File headers are not good candidates for kerneldoc. > > Fixes the following W=1 kernel build warning(s): > > drivers/iio/dummy/iio_simple_dummy_events.c:21: warning: Incorrect use of kernel-doc format: * iio_simple_dummy_read_event_config() - is event enabled? > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'indio_dev' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'chan' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'type' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'dir' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:123: warning: Function parameter or member 'val2' not described in 'iio_simple_dummy_read_event_value' > drivers/iio/dummy/iio_simple_dummy_events.c:146: warning: Function parameter or member 'val2' not described in 'iio_simple_dummy_write_event_value' > > Signed-off-by: Lee Jones Applied. J > --- > drivers/iio/dummy/iio_simple_dummy_events.c | 4 +++- > 1 file changed, 3 insertions(+), 1 deletion(-) > > diff --git a/drivers/iio/dummy/iio_simple_dummy_events.c b/drivers/iio/dummy/iio_simple_dummy_events.c > index b3abaaca6f5ef..63a2b844be508 100644 > --- a/drivers/iio/dummy/iio_simple_dummy_events.c > +++ b/drivers/iio/dummy/iio_simple_dummy_events.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * Copyright (c) 2011 Jonathan Cameron > * > * Event handling elements of industrial I/O reference driver. > @@ -107,6 +107,7 @@ int iio_simple_dummy_write_event_config(struct iio_dev *indio_dev, > * @dir: direction of the vent whose value is being read > * @info: info type of the event whose value is being read > * @val: value for the event code. > + * @val2: unused > * > * Many devices provide a large set of events of which only a subset may > * be enabled at a time, with value registers whose meaning changes depending > @@ -136,6 +137,7 @@ int iio_simple_dummy_read_event_value(struct iio_dev *indio_dev, > * @dir: direction of the vent whose value is being set > * @info: info type of the event whose value is being set > * @val: the value to be set. > + * @val2: unused > */ > int iio_simple_dummy_write_event_value(struct iio_dev *indio_dev, > const struct iio_chan_spec *chan, 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 897F2C433E0 for ; Sat, 18 Jul 2020 14:57:04 +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 563CB20656 for ; Sat, 18 Jul 2020 14:57:04 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="VhgHYBCQ"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="mYFSpyom" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 563CB20656 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=Vr5NVSXDc+5vdxeLZqdJjoh/QwWd3AZT/Y4PWIDtRh0=; b=VhgHYBCQRlLLGthmcyZC6+AOO YnZpuwIIcyV+2OCQPbDF8Z5+9+ylutLQvRvxJj/Lq/25xNQHu1BUprJbHsebargkskLMY6ZsJnNta TTRRgR3XVudtjjiJSvy1rrS95+pubi7IgG2alYMDpddvH+n/J9Wb17obQhyBzjavnI0876tHMdyiL rwATLKRpi9Ke4gmgTzh10CNeqqiKLGOi9txAjGtva7LTZhx0lBiBNUar1ZIKY0sEr4jcxhTLEWQGu T6dYmvaTTZKEFEa2u/+hjBwxPphDdlHp69jOFSxbNfRrX0Twz59JUssc1hf1cMbqDj0eXDspRZnVv H4dx/JIMQ==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jwoFe-0005vx-TW; Sat, 18 Jul 2020 14:55:46 +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 1jwoFc-0005vI-Dj for linux-arm-kernel@lists.infradead.org; Sat, 18 Jul 2020 14:55:45 +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 88D6220656; Sat, 18 Jul 2020 14:55:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595084143; bh=kjZhliArAupsgIQRojSt1mgRcPYN3aZHfo2EkpA7vg8=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=mYFSpyomkpTz4MVFl/SQ7vvPF/V54xzhpgc1ehuw3X3BY+Kr8Cz8mMK88/N0XesoP mgk069jE0kqOkmTlVgQ4p3eOZAGC6F9wdqHfLOUEn2+yyT+3Am7htoxWL7Hdi/444C o83OjwOBfSGHV0ah4NEIQNicRJTg565NQIVg/8Wo= Date: Sat, 18 Jul 2020 15:55:39 +0100 From: Jonathan Cameron To: Lee Jones Subject: Re: [PATCH 13/30] iio: dummy: iio_simple_dummy_events: Demote file header and supply descriptions for val2 params Message-ID: <20200718155539.48913015@archlinux> In-Reply-To: <20200716135928.1456727-14-lee.jones@linaro.org> References: <20200716135928.1456727-1-lee.jones@linaro.org> <20200716135928.1456727-14-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_105544_616083_74E48431 X-CRM114-Status: GOOD ( 17.48 ) 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:11 +0100 Lee Jones wrote: > File headers are not good candidates for kerneldoc. > > Fixes the following W=1 kernel build warning(s): > > drivers/iio/dummy/iio_simple_dummy_events.c:21: warning: Incorrect use of kernel-doc format: * iio_simple_dummy_read_event_config() - is event enabled? > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'indio_dev' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'chan' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'type' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:34: warning: Function parameter or member 'dir' not described in 'iio_simple_dummy_read_event_config' > drivers/iio/dummy/iio_simple_dummy_events.c:123: warning: Function parameter or member 'val2' not described in 'iio_simple_dummy_read_event_value' > drivers/iio/dummy/iio_simple_dummy_events.c:146: warning: Function parameter or member 'val2' not described in 'iio_simple_dummy_write_event_value' > > Signed-off-by: Lee Jones Applied. J > --- > drivers/iio/dummy/iio_simple_dummy_events.c | 4 +++- > 1 file changed, 3 insertions(+), 1 deletion(-) > > diff --git a/drivers/iio/dummy/iio_simple_dummy_events.c b/drivers/iio/dummy/iio_simple_dummy_events.c > index b3abaaca6f5ef..63a2b844be508 100644 > --- a/drivers/iio/dummy/iio_simple_dummy_events.c > +++ b/drivers/iio/dummy/iio_simple_dummy_events.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * Copyright (c) 2011 Jonathan Cameron > * > * Event handling elements of industrial I/O reference driver. > @@ -107,6 +107,7 @@ int iio_simple_dummy_write_event_config(struct iio_dev *indio_dev, > * @dir: direction of the vent whose value is being read > * @info: info type of the event whose value is being read > * @val: value for the event code. > + * @val2: unused > * > * Many devices provide a large set of events of which only a subset may > * be enabled at a time, with value registers whose meaning changes depending > @@ -136,6 +137,7 @@ int iio_simple_dummy_read_event_value(struct iio_dev *indio_dev, > * @dir: direction of the vent whose value is being set > * @info: info type of the event whose value is being set > * @val: the value to be set. > + * @val2: unused > */ > int iio_simple_dummy_write_event_value(struct iio_dev *indio_dev, > const struct iio_chan_spec *chan, _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel