Linux-GPIO Archive on lore.kernel.org
 help / color / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: linus.walleij@linaro.org, bgolaszewski@baylibre.com
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org,
	"Lee Jones" <lee.jones@linaro.org>,
	"Diego Elio Pettenò" <flameeyes@flameeyes.eu>
Subject: [PATCH 07/10] gpio: gpio-it87: Fix formatting issues which confuse kerneldoc
Date: Tue, 30 Jun 2020 14:33:42 +0100
Message-ID: <20200630133345.2232932-8-lee.jones@linaro.org> (raw)
In-Reply-To: <20200630133345.2232932-1-lee.jones@linaro.org>

Kerneldoc expects struct properties to be documented using the syntax
'@.*: ', but no ':' has been provided in 'struct it87_gpio's
header.  Add them to stop confusing kerneldoc.

Fixes the following W=1 warnings:

 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'chip' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'lock' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'io_base' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'io_size' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'output_base' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'simple_base' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'simple_size' not described in 'it87_gpio'

Cc: "Diego Elio Pettenò" <flameeyes@flameeyes.eu>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-it87.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/gpio/gpio-it87.c b/drivers/gpio/gpio-it87.c
index b497a1d18ca9b..8f1be34953ce4 100644
--- a/drivers/gpio/gpio-it87.c
+++ b/drivers/gpio/gpio-it87.c
@@ -47,13 +47,13 @@
 
 /**
  * struct it87_gpio - it87-specific GPIO chip
- * @chip the underlying gpio_chip structure
- * @lock a lock to avoid races between operations
- * @io_base base address for gpio ports
- * @io_size size of the port rage starting from io_base.
- * @output_base Super I/O register address for Output Enable register
- * @simple_base Super I/O 'Simple I/O' Enable register
- * @simple_size Super IO 'Simple I/O' Enable register size; this is
+ * @chip: the underlying gpio_chip structure
+ * @lock: a lock to avoid races between operations
+ * @io_base: base address for gpio ports
+ * @io_size: size of the port rage starting from io_base.
+ * @output_base: Super I/O register address for Output Enable register
+ * @simple_base: Super I/O 'Simple I/O' Enable register
+ * @simple_size: Super IO 'Simple I/O' Enable register size; this is
  *	required because IT87xx chips might only provide Simple I/O
  *	switches on a subset of lines, whereas the others keep the
  *	same status all time.
-- 
2.25.1


  parent reply index

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
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 ` Lee Jones [this message]
2020-07-08  7:19   ` [PATCH 07/10] gpio: gpio-it87: " 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=20200630133345.2232932-8-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=bgolaszewski@baylibre.com \
    --cc=flameeyes@flameeyes.eu \
    --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

Linux-GPIO Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-gpio/0 linux-gpio/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-gpio linux-gpio/ https://lore.kernel.org/linux-gpio \
		linux-gpio@vger.kernel.org
	public-inbox-index linux-gpio

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-gpio


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git