From: Bjorn Andersson <bjorn.andersson@linaro.org>
To: Lee Jones <lee.jones@linaro.org>
Cc: jic23@kernel.org, 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,
Andy Gross <agross@kernel.org>,
Linus Walleij <linus.walleij@linaro.org>,
linux-arm-msm@vger.kernel.org
Subject: Re: [PATCH 26/30] iio: adc: qcom-pm8xxx-xoadc: Demote standard comment block and supply missing description
Date: Fri, 17 Jul 2020 13:15:25 -0700 [thread overview]
Message-ID: <20200717201525.GK388985@builder.lan> (raw)
In-Reply-To: <20200717165538.3275050-27-lee.jones@linaro.org>
On Fri 17 Jul 09:55 PDT 2020, Lee Jones wrote:
> Kerneldoc is only suitable for documenting functions and struct/enums.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL' description in 'PM8XXX_CHANNEL_INTERNAL'
> drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_125V' description in 'PM8XXX_CHANNEL_INTERNAL'
> drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL_2' description in 'PM8XXX_CHANNEL_INTERNAL'
> drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_MUXOFF' description in 'PM8XXX_CHANNEL_INTERNAL'
> drivers/iio/adc/qcom-pm8xxx-xoadc.c:412: warning: Function parameter or member 'variant' not described in 'pm8xxx_xoadc'
>
> Cc: Andy Gross <agross@kernel.org>
> Cc: Bjorn Andersson <bjorn.andersson@linaro.org>
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Cc: linux-arm-msm@vger.kernel.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
> ---
> drivers/iio/adc/qcom-pm8xxx-xoadc.c | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/iio/adc/qcom-pm8xxx-xoadc.c b/drivers/iio/adc/qcom-pm8xxx-xoadc.c
> index c599ffa45a04c..cd5fa30e77df4 100644
> --- a/drivers/iio/adc/qcom-pm8xxx-xoadc.c
> +++ b/drivers/iio/adc/qcom-pm8xxx-xoadc.c
> @@ -120,7 +120,7 @@
> #define ADC_ARB_USRP_DATA0 0x19D
> #define ADC_ARB_USRP_DATA1 0x19C
>
> -/**
> +/*
> * Physical channels which MUST exist on all PM variants in order to provide
> * proper reference points for calibration.
> *
> @@ -388,6 +388,7 @@ struct pm8xxx_chan_info {
> * struct pm8xxx_xoadc - state container for the XOADC
> * @dev: pointer to device
> * @map: regmap to access registers
> + * @variant: XOADC variant characteristics
> * @vref: reference voltage regulator
> * characteristics of the channels, and sensible default settings
> * @nchans: number of channels, configured by the device tree
> --
> 2.25.1
>
next prev parent reply other threads:[~2020-07-17 20:17 UTC|newest]
Thread overview: 65+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-17 16:55 [PATCH 00/30] Second batch of W=1 fixes for IIO Lee Jones
2020-07-17 16:55 ` [PATCH 01/30] iio: adc: ti_am335x_adc: Remove a couple of unused 'read' variables Lee Jones
2020-07-18 15:30 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 02/30] iio: adc: twl4030-madc: Remove set but unused variables 'len' Lee Jones
2020-07-18 15:32 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 03/30] iio: adc: twl4030-madc: Fix misnamed struct attribute Lee Jones
2020-07-18 15:33 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 04/30] iio: magnetometer: hmc5843: 'hmc5843_pm_ops' is unused in 1 of 3 files including hmc5843_core.h Lee Jones
2020-07-18 15:34 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 05/30] iio: adc: twl6030-gpadc: Fix some misdocumentation and formatting issues Lee Jones
2020-07-18 15:38 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 06/30] iio: dac: ltc2632: Fix formatting in kerneldoc struct header Lee Jones
2020-07-18 15:39 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 07/30] iio: light: si1145: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 15:40 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 08/30] iio: resolver: ad2s1200: Change ordering of compiler attribute macro Lee Jones
2020-07-18 15:41 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 09/30] iio: temperature: mlx90632: Function parameter descriptions must match exactly Lee Jones
2020-07-17 19:48 ` Crt Mori
2020-07-18 15:42 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 10/30] iio: light: us5182d: Fix formatting in kerneldoc function block Lee Jones
2020-07-18 15:44 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 11/30] iio: adc: ad799x: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-18 15:47 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 12/30] iio: dac: ad5504: Fix formatting errors and demote non-compliant kerneldoc Lee Jones
2020-07-18 15:48 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 13/30] iio: adc: at91_adc: Fix 'bad line' warning Lee Jones
2020-07-18 15:48 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 14/30] iio: adc: at91-sama5d2_adc: Struct kerneldoc titles need to start with 'struct ' Lee Jones
2020-07-18 15:49 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 15/30] iio: adc: cpcap-adc: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-18 15:50 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 16/30] iio: accel: sca3000: Fix 2 misspellings and demote nonconforming kerneldocs Lee Jones
2020-07-18 15:51 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 17/30] iio: gyro: adxrs450: Change ordering of compiler attribute macro Lee Jones
2020-07-18 15:52 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 18/30] iio: gyro: fxas21002c: Move 'fxas21002c_reg_fields' to the only file its used Lee Jones
2020-07-18 15:54 ` Jonathan Cameron
2020-07-22 20:20 ` Rui Miguel Silva
2020-07-17 16:55 ` [PATCH 19/30] iio: imu: st_lsm6dsx: st_lsm6dsx: Reorder 'inline' declaration Lee Jones
2020-07-18 15:54 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 20/30] iio: adc: max1363: Fix kerneldoc attribute formatting for 'lock' Lee Jones
2020-07-18 15:56 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 21/30] iio: adc: max9611: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 15:59 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 22/30] iio: adc: mcp320x: Change ordering of compiler attribute macro Lee Jones
2020-07-18 16:00 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 23/30] iio: adc: palmas_gpadc: Demote non-conforming kerneldoc header Lee Jones
2020-07-18 16:01 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 24/30] iio: imu: inv_mpu6050: inv_mpu_core: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 16:02 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 25/30] iio: imu: inv_mpu6050: inv_mpu_ring: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-18 16:03 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 26/30] iio: adc: qcom-pm8xxx-xoadc: Demote standard comment block and supply missing description Lee Jones
2020-07-17 20:15 ` Bjorn Andersson [this message]
2020-07-18 16:06 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 27/30] iio: magnetometer: ak8974: Add description for ak8974's 'scan' attribute Lee Jones
2020-07-18 16:08 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 28/30] iio: imu: st_lsm6dsx: st_lsm6dsx_shub: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 16:13 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 29/30] iio: imu: st_lsm6dsx: st_lsm6dsx: Mark 'st_lsm6dsx_accel_ext_info' as __maybe_unused Lee Jones
2020-07-18 16:14 ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 30/30] iio: adc: rockchip_saradc: Demote Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-17 19:10 ` Heiko Stübner
2020-07-18 16:15 ` Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200717201525.GK388985@builder.lan \
--to=bjorn.andersson@linaro.org \
--cc=agross@kernel.org \
--cc=jic23@kernel.org \
--cc=knaack.h@gmx.de \
--cc=lars@metafoo.de \
--cc=lee.jones@linaro.org \
--cc=linus.walleij@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pmeerw@pmeerw.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).