linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Linus Walleij <linus.walleij@linaro.org>,
	Bartosz Golaszewski <bgolaszewski@baylibre.com>,
	linux-gpio@vger.kernel.org
Subject: [PATCH 08/29] gpio: driver.h: fix kernel-doc markup
Date: Mon, 15 Jun 2020 08:46:47 +0200	[thread overview]
Message-ID: <97beeedde507eaeea189ae955c9f35ecf1563d6d.1592203542.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1592203542.git.mchehab+huawei@kernel.org>

There is one parameter with a wrong name at kernel-doc macro:

./include/linux/gpio/driver.h:499: warning: Function parameter or member 'gc' not described in 'gpiochip_add_data'
./include/linux/gpio/driver.h:499: warning: Excess function parameter 'chip' description in 'gpiochip_add_data'

Fix it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 include/linux/gpio/driver.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index c4f272af7af5..c11261f3c724 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 
 /**
  * gpiochip_add_data() - register a gpio_chip
- * @chip: the chip to register, with chip->base initialized
+ * @gc: the chip to register, with chip->base initialized
  * @data: driver-private data associated with this chip
  *
  * Context: potentially before irqs will work
-- 
2.26.2


  parent reply	other threads:[~2020-06-15  6:49 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1592203542.git.mchehab+huawei@kernel.org>
2020-06-15  6:46 ` [PATCH 01/29] mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 02/29] net: dev: add a missing kernel-doc annotation Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 03/29] net: netdevice.h: add a description for napi_defer_hard_irqs Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 04/29] scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 05/29] net: pylink.h: add kernel-doc descriptions for new fields at phylink_config Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 06/29] scripts/kernel-doc: handle function pointer prototypes Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 07/29] fs: fs.h: fix a kernel-doc parameter description Mauro Carvalho Chehab
2020-06-15  8:47   ` Jan Kara
2020-06-15  6:46 ` Mauro Carvalho Chehab [this message]
2020-06-15  8:05   ` [PATCH 08/29] gpio: driver.h: fix kernel-doc markup Bartosz Golaszewski
2020-06-15  6:46 ` [PATCH 09/29] kcsan: fix a kernel-doc warning Mauro Carvalho Chehab
2020-06-15  6:56   ` Marco Elver
2020-06-15  6:46 ` [PATCH 10/29] rcu: fix some kernel-doc warnings Mauro Carvalho Chehab
2020-06-15 20:36   ` Paul E. McKenney
2020-06-15  6:46 ` [PATCH 11/29] fs: docs: f2fs.rst: fix a broken table Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 12/29] dt: update a reference for reneases pcar file renamed to yaml Mauro Carvalho Chehab
2020-06-15  7:38   ` Geert Uytterhoeven
2020-06-18 16:41   ` Rob Herring
2020-06-15  6:46 ` [PATCH 13/29] dt: fix broken links due to txt->yaml renames Mauro Carvalho Chehab
2020-06-15  8:13   ` Thomas Bogendoerfer
2020-06-15 11:19   ` Mark Brown
2020-06-15 11:57     ` Mauro Carvalho Chehab
2020-06-15 12:01       ` Mark Brown
2020-06-18 16:44   ` Rob Herring
2020-06-15  6:46 ` [PATCH 14/29] dt: Fix broken references to renamed docs Mauro Carvalho Chehab
2020-06-15  7:48   ` Philipp Zabel
2020-06-15 11:18   ` Mark Brown
2020-06-18 17:06   ` Rob Herring
2020-06-15  6:46 ` [PATCH 15/29] dt: fix reference to olpc,xo1.75-ec.txt Mauro Carvalho Chehab
2020-06-16  8:20   ` Lubomir Rintel
2020-06-18 17:19   ` Rob Herring
2020-06-15  6:46 ` [PATCH 16/29] selftests/vm/keys: fix a broken reference at protection_keys.c Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 17/29] docs: hugetlbpage.rst: fix some warnings Mauro Carvalho Chehab
2020-06-15 11:52   ` Matthew Wilcox
2020-06-15  6:46 ` [PATCH 18/29] docs: powerpc: fix some issues at vas-api.rst Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 19/29] docs: driver-model: remove a duplicated markup at driver.rst Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 20/29] docs: watch_queue.rst: supress some Sphinx warnings and move to core-api Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 21/29] docs: device-mapper: add dm-ebs.rst to an index file Mauro Carvalho Chehab
2020-06-19 16:18   ` Mike Snitzer
2020-06-15  6:47 ` [PATCH 22/29] docs: it_IT: add two missing references Mauro Carvalho Chehab
2020-06-15  7:39   ` Federico Vaga
2020-06-15  6:47 ` [PATCH 23/29] docs: ABI: fix a typo when pointing to w1-generic.rst Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 24/29] docs: fs: locking.rst: fix a broken table Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 25/29] docs: add bus-virt-phys-mapping.txt to core-api Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 26/29] docs: fix references for DMA*.txt files Mauro Carvalho Chehab
2020-06-15 20:37   ` Paul E. McKenney
2020-06-15  6:47 ` [PATCH 27/29] docs: dt: minor adjustments at writing-schema.rst Mauro Carvalho Chehab
2020-06-18 17:20   ` Rob Herring
2020-06-15  6:47 ` [PATCH 28/29] docs: fs: proc.rst: fix a warning due to a merge conflict Mauro Carvalho Chehab
2020-06-15 11:17   ` Mark Brown
2020-06-15 18:24   ` Kees Cook
2020-06-15  6:47 ` [PATCH 29/29] docs: fs: proc.rst: convert a new chapter to ReST Mauro Carvalho Chehab
2020-06-15 18:24   ` Kees Cook

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=97beeedde507eaeea189ae955c9f35ecf1563d6d.1592203542.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=bgolaszewski@baylibre.com \
    --cc=corbet@lwn.net \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.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).