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 514EAC433E1 for ; Sat, 18 Jul 2020 15:09:28 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 31CCF2076A for ; Sat, 18 Jul 2020 15:09:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595084968; bh=JEeQ6EAJdaIpOY15yE8+2poMV0kARRFf/ZiGMh4qNLM=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=eT7Ux9DX5TuMpTCXgRbJZ7JN2cJJwvLT5NySVrTANrYdGB1ETVSuOOKCAKXhCsKyE BlMKA93fmVaM8lByxmkPao75jIARp5AehmKWSx7jj4+E2YUwyp4gCn6gKLzNU6P4eS YnWqKrR4l4zyewX0gTxjhK+ia95PqPZulb+6bNmo= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726828AbgGRPJ0 (ORCPT ); Sat, 18 Jul 2020 11:09:26 -0400 Received: from mail.kernel.org ([198.145.29.99]:37044 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726155AbgGRPJZ (ORCPT ); Sat, 18 Jul 2020 11:09:25 -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 B03812067D; Sat, 18 Jul 2020 15:09:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595084965; bh=JEeQ6EAJdaIpOY15yE8+2poMV0kARRFf/ZiGMh4qNLM=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=GyJDid9F+uZJehWRKqkaXT9HYU2HjP0UKPhiMKMhSoPyH3c9KsylM4JHI3iuZLaSb T37x3pyOcipBZq/4CrQeEtiKSu0z95XDtbI9AOFxoaeiLp0Ej0+s/rvUSqR994CzpQ 7FOi5urFmmWq+38N+u2TEVLe78W8tDagTvjTHgtg= Date: Sat, 18 Jul 2020 16:09:20 +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, Michael Hennerich , Stefan Popa Subject: Re: [PATCH 23/30] iio: dac: ad5758: Move and fix-up kerneldoc header and demote unworthy kerneldoc Message-ID: <20200718160920.2f67428c@archlinux> In-Reply-To: <20200716135928.1456727-24-lee.jones@linaro.org> References: <20200716135928.1456727-1-lee.jones@linaro.org> <20200716135928.1456727-24-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:21 +0100 Lee Jones wrote: > Kerneldoc headers need to come directly before the function/struct > that they are documenting. Also fix some missing descriptions and > misspellings. > > Fixes the following W=1 kernel build warning(s): > > drivers/iio/dac/ad5758.c:111: warning: Function parameter or member 'reg' not described in 'ad5758_range' > drivers/iio/dac/ad5758.c:111: warning: Function parameter or member 'min' not described in 'ad5758_range' > drivers/iio/dac/ad5758.c:111: warning: Function parameter or member 'max' not described in 'ad5758_range' > drivers/iio/dac/ad5758.c:122: warning: Function parameter or member 'gpio_reset' not described in 'ad5758_state' > drivers/iio/dac/ad5758.c:122: warning: Function parameter or member 'd32' not described in 'ad5758_state' > drivers/iio/dac/ad5758.c:137: warning: cannot understand function prototype: 'enum ad5758_output_range ' > > Cc: Michael Hennerich > Cc: Stefan Popa > Signed-off-by: Lee Jones Applied to the togreg branch of iio.git and pushed out as testing. Plenty of time to add tags or changes if anyone else reviews. Thanks, Jonathan > --- > drivers/iio/dac/ad5758.c | 18 +++++++++--------- > 1 file changed, 9 insertions(+), 9 deletions(-) > > diff --git a/drivers/iio/dac/ad5758.c b/drivers/iio/dac/ad5758.c > index 475646c82b40e..c34740d2c89a1 100644 > --- a/drivers/iio/dac/ad5758.c > +++ b/drivers/iio/dac/ad5758.c > @@ -92,24 +92,24 @@ > > #define AD5758_FULL_SCALE_MICRO 65535000000ULL > > +struct ad5758_range { > + int reg; > + int min; > + int max; > +}; > + > /** > * struct ad5758_state - driver instance specific data > * @spi: spi_device > * @lock: mutex lock > + * @gpio_reset: gpio descriptor for the reset line > * @out_range: struct which stores the output range > * @dc_dc_mode: variable which stores the mode of operation > * @dc_dc_ilim: variable which stores the dc-to-dc converter current limit > * @slew_time: variable which stores the target slew time > * @pwr_down: variable which contains whether a channel is powered down or not > - * @data: spi transfer buffers > + * @d32: spi transfer buffers > */ > - > -struct ad5758_range { > - int reg; > - int min; > - int max; > -}; > - > struct ad5758_state { > struct spi_device *spi; > struct mutex lock; > @@ -122,7 +122,7 @@ struct ad5758_state { > __be32 d32[3]; > }; > > -/** > +/* > * Output ranges corresponding to bits [3:0] from DAC_CONFIG register > * 0000: 0 V to 5 V voltage range > * 0001: 0 V to 10 V voltage range 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 C88B4C433E4 for ; Sat, 18 Jul 2020 15:10:58 +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 934EA2076A for ; Sat, 18 Jul 2020 15:10:58 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="vCVhS9Xz"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="GyJDid9F" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 934EA2076A 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=XzU6kkLWksxlN54lq3U1EBDrUNTxNTx7qtgPIG54AwI=; b=vCVhS9Xzs/4/EeMDvuwTBAK4V sSwIr9Y94KJyL7RXtDIknFAE6Yj/6Lp7izSPcmg2J4xoJ/PcNQo0LUFCrqariKwNS+rcdBe3WIcOc 6xTok+pTEmU0/L4CSVmJ5RU8cNG2tOLhIiWOFenx0A1QNGsUsK1gvO1EgUOf5L85dS6iO1tMxd1Dm Rt4SyqonYI4j8fdxfYHYEjThqNo+YFGlWVHx9p1pSsJHDxgd3o5A613G+ghlnCmft0Jkk2sgWb5mJ rozLSoCUpgluP+2jO+2QsNoHugSYI6ew+Os2OPKYC+FcExiWF0bJkzGQnsw0VKL/5MsK46NbAu1sg 2/5N/GunA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jwoSu-0001Io-I2; Sat, 18 Jul 2020 15:09:28 +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 1jwoSr-0001Hv-Qy for linux-arm-kernel@lists.infradead.org; Sat, 18 Jul 2020 15:09:26 +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 B03812067D; Sat, 18 Jul 2020 15:09:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1595084965; bh=JEeQ6EAJdaIpOY15yE8+2poMV0kARRFf/ZiGMh4qNLM=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=GyJDid9F+uZJehWRKqkaXT9HYU2HjP0UKPhiMKMhSoPyH3c9KsylM4JHI3iuZLaSb T37x3pyOcipBZq/4CrQeEtiKSu0z95XDtbI9AOFxoaeiLp0Ej0+s/rvUSqR994CzpQ 7FOi5urFmmWq+38N+u2TEVLe78W8tDagTvjTHgtg= Date: Sat, 18 Jul 2020 16:09:20 +0100 From: Jonathan Cameron To: Lee Jones Subject: Re: [PATCH 23/30] iio: dac: ad5758: Move and fix-up kerneldoc header and demote unworthy kerneldoc Message-ID: <20200718160920.2f67428c@archlinux> In-Reply-To: <20200716135928.1456727-24-lee.jones@linaro.org> References: <20200716135928.1456727-1-lee.jones@linaro.org> <20200716135928.1456727-24-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_110926_057797_12A282C5 X-CRM114-Status: GOOD ( 17.88 ) 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, Stefan Popa , Michael Hennerich , 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:21 +0100 Lee Jones wrote: > Kerneldoc headers need to come directly before the function/struct > that they are documenting. Also fix some missing descriptions and > misspellings. > > Fixes the following W=1 kernel build warning(s): > > drivers/iio/dac/ad5758.c:111: warning: Function parameter or member 'reg' not described in 'ad5758_range' > drivers/iio/dac/ad5758.c:111: warning: Function parameter or member 'min' not described in 'ad5758_range' > drivers/iio/dac/ad5758.c:111: warning: Function parameter or member 'max' not described in 'ad5758_range' > drivers/iio/dac/ad5758.c:122: warning: Function parameter or member 'gpio_reset' not described in 'ad5758_state' > drivers/iio/dac/ad5758.c:122: warning: Function parameter or member 'd32' not described in 'ad5758_state' > drivers/iio/dac/ad5758.c:137: warning: cannot understand function prototype: 'enum ad5758_output_range ' > > Cc: Michael Hennerich > Cc: Stefan Popa > Signed-off-by: Lee Jones Applied to the togreg branch of iio.git and pushed out as testing. Plenty of time to add tags or changes if anyone else reviews. Thanks, Jonathan > --- > drivers/iio/dac/ad5758.c | 18 +++++++++--------- > 1 file changed, 9 insertions(+), 9 deletions(-) > > diff --git a/drivers/iio/dac/ad5758.c b/drivers/iio/dac/ad5758.c > index 475646c82b40e..c34740d2c89a1 100644 > --- a/drivers/iio/dac/ad5758.c > +++ b/drivers/iio/dac/ad5758.c > @@ -92,24 +92,24 @@ > > #define AD5758_FULL_SCALE_MICRO 65535000000ULL > > +struct ad5758_range { > + int reg; > + int min; > + int max; > +}; > + > /** > * struct ad5758_state - driver instance specific data > * @spi: spi_device > * @lock: mutex lock > + * @gpio_reset: gpio descriptor for the reset line > * @out_range: struct which stores the output range > * @dc_dc_mode: variable which stores the mode of operation > * @dc_dc_ilim: variable which stores the dc-to-dc converter current limit > * @slew_time: variable which stores the target slew time > * @pwr_down: variable which contains whether a channel is powered down or not > - * @data: spi transfer buffers > + * @d32: spi transfer buffers > */ > - > -struct ad5758_range { > - int reg; > - int min; > - int max; > -}; > - > struct ad5758_state { > struct spi_device *spi; > struct mutex lock; > @@ -122,7 +122,7 @@ struct ad5758_state { > __be32 d32[3]; > }; > > -/** > +/* > * Output ranges corresponding to bits [3:0] from DAC_CONFIG register > * 0000: 0 V to 5 V voltage range > * 0001: 0 V to 10 V voltage range _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel