From: Ludovic Desroches <ludovic.desroches@microchip.com>
To: Lee Jones <lee.jones@linaro.org>
Cc: linus.walleij@linaro.org, bgolaszewski@baylibre.com,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org,
Andrei Stefanescu <andrei.stefanescu@microchip.com>
Subject: Re: [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks
Date: Wed, 1 Jul 2020 09:05:35 +0200 [thread overview]
Message-ID: <20200701070535.stnl53wxyez6hcpt@sekiro> (raw)
In-Reply-To: <20200630133345.2232932-6-lee.jones@linaro.org>
On Tue, Jun 30, 2020 at 02:33:40PM +0100, Lee Jones wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
>
> No attempt has been made to provide proper descriptions for each of
> the function arguments throughout the file. Simply demote all
> kerneldoc headers to basic function headers.
>
> Fixes the following W=1 kernel build warnings:
>
> drivers/gpio/gpio-sama5d2-piobu.c:59: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_setup_pin'
> drivers/gpio/gpio-sama5d2-piobu.c:59: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_setup_pin'
> drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_write_value'
> drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_write_value'
> drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'mask' not described in 'sama5d2_piobu_write_value'
> drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_write_value'
> drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_read_value'
> drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_read_value'
> drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'mask' not described in 'sama5d2_piobu_read_value'
> drivers/gpio/gpio-sama5d2-piobu.c:116: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_get_direction'
> drivers/gpio/gpio-sama5d2-piobu.c:116: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_get_direction'
> drivers/gpio/gpio-sama5d2-piobu.c:131: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_direction_input'
> drivers/gpio/gpio-sama5d2-piobu.c:131: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_direction_input'
> drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_direction_output'
> drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_direction_output'
> drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_direction_output'
> drivers/gpio/gpio-sama5d2-piobu.c:154: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_get'
> drivers/gpio/gpio-sama5d2-piobu.c:154: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_get'
> drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_set'
> drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_set'
> drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_set'
>
> Cc: Ludovic Desroches <ludovic.desroches@microchip.com>
> Cc: Andrei Stefanescu <andrei.stefanescu@microchip.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
Acked-by: Ludovic Desroches <ludovic.desroches@microchip.com>
Thanks.
> ---
> drivers/gpio/gpio-sama5d2-piobu.c | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/gpio/gpio-sama5d2-piobu.c b/drivers/gpio/gpio-sama5d2-piobu.c
> index 4d47b2c411868..b7c9506581701 100644
> --- a/drivers/gpio/gpio-sama5d2-piobu.c
> +++ b/drivers/gpio/gpio-sama5d2-piobu.c
> @@ -49,7 +49,7 @@ struct sama5d2_piobu {
> struct regmap *regmap;
> };
>
> -/**
> +/*
> * sama5d2_piobu_setup_pin() - prepares a pin for set_direction call
> *
> * Do not consider pin for tamper detection (normal and backup modes)
> @@ -73,7 +73,7 @@ static int sama5d2_piobu_setup_pin(struct gpio_chip *chip, unsigned int pin)
> return regmap_update_bits(piobu->regmap, PIOBU_WKPR, mask, 0);
> }
>
> -/**
> +/*
> * sama5d2_piobu_write_value() - writes value & mask at the pin's PIOBU register
> */
> static int sama5d2_piobu_write_value(struct gpio_chip *chip, unsigned int pin,
> @@ -88,7 +88,7 @@ static int sama5d2_piobu_write_value(struct gpio_chip *chip, unsigned int pin,
> return regmap_update_bits(piobu->regmap, reg, mask, value);
> }
>
> -/**
> +/*
> * sama5d2_piobu_read_value() - read the value with masking from the pin's PIOBU
> * register
> */
> @@ -108,7 +108,7 @@ static int sama5d2_piobu_read_value(struct gpio_chip *chip, unsigned int pin,
> return val & mask;
> }
>
> -/**
> +/*
> * sama5d2_piobu_get_direction() - gpiochip get_direction
> */
> static int sama5d2_piobu_get_direction(struct gpio_chip *chip,
> @@ -123,7 +123,7 @@ static int sama5d2_piobu_get_direction(struct gpio_chip *chip,
> GPIO_LINE_DIRECTION_OUT;
> }
>
> -/**
> +/*
> * sama5d2_piobu_direction_input() - gpiochip direction_input
> */
> static int sama5d2_piobu_direction_input(struct gpio_chip *chip,
> @@ -132,7 +132,7 @@ static int sama5d2_piobu_direction_input(struct gpio_chip *chip,
> return sama5d2_piobu_write_value(chip, pin, PIOBU_DIRECTION, PIOBU_IN);
> }
>
> -/**
> +/*
> * sama5d2_piobu_direction_output() - gpiochip direction_output
> */
> static int sama5d2_piobu_direction_output(struct gpio_chip *chip,
> @@ -147,7 +147,7 @@ static int sama5d2_piobu_direction_output(struct gpio_chip *chip,
> val);
> }
>
> -/**
> +/*
> * sama5d2_piobu_get() - gpiochip get
> */
> static int sama5d2_piobu_get(struct gpio_chip *chip, unsigned int pin)
> @@ -166,7 +166,7 @@ static int sama5d2_piobu_get(struct gpio_chip *chip, unsigned int pin)
> return !!ret;
> }
>
> -/**
> +/*
> * sama5d2_piobu_set() - gpiochip set
> */
> static void sama5d2_piobu_set(struct gpio_chip *chip, unsigned int pin,
> --
> 2.25.1
>
next prev parent reply other threads:[~2020-07-01 7:05 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
2020-06-30 13:33 ` [PATCH 01/10] gpio: gpiolib-of: Provide documentation for of_gpio_spi_cs_get_count() Lee Jones
2020-07-08 7:14 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 02/10] gpio: gpio-altera: Add missing kerneldoc entry and demote comment Lee Jones
2020-07-08 7:15 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data Lee Jones
2020-06-30 14:01 ` Andy Shevchenko
2020-06-30 13:33 ` [PATCH 04/10] gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map' Lee Jones
2020-06-30 15:01 ` Baolin Wang
2020-07-08 7:16 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks Lee Jones
2020-07-01 7:05 ` Ludovic Desroches [this message]
2020-07-08 7:17 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 06/10] gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc Lee Jones
2020-07-08 7:18 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 07/10] gpio: gpio-it87: " Lee Jones
2020-07-08 7:19 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 08/10] gpio: gpio-mlxbf: Tell the compiler that ACPI functions may not be used Lee Jones
2020-07-08 7:20 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use Lee Jones
2020-06-30 14:17 ` Asmaa Mnebhi
2020-07-08 7:22 ` Linus Walleij
2020-06-30 13:33 ` [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse Lee Jones
2020-06-30 14:18 ` Asmaa Mnebhi
2020-07-08 7:23 ` Linus Walleij
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=20200701070535.stnl53wxyez6hcpt@sekiro \
--to=ludovic.desroches@microchip.com \
--cc=andrei.stefanescu@microchip.com \
--cc=bgolaszewski@baylibre.com \
--cc=lee.jones@linaro.org \
--cc=linus.walleij@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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).