linux-kernel - [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20200717185624.2009393-7-dwlsalmeida@gmail.com>
Date:   Fri, 17 Jul 2020 15:56:06 -0300
From:   "Daniel W. S. Almeida" <dwlsalmeida@...il.com>
To:     corbet@....net, mchehab@...nel.org
Cc:     "Daniel W. S. Almeida" <dwlsalmeida@...il.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

From: "Daniel W. S. Almeida" <dwlsalmeida@...il.com>

Fix the following warnings:

warning: Function parameter or member 'gc' not described in
'gpiochip_add_data'

warning: Excess function parameter 'chip' description in
'gpiochip_add_data'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@...il.com>
---
 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 c4f272af7af59..c11261f3c7247 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.27.0