Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

gpio: Correct kernel-doc inconsistency

Fix kernel-doc comment to match parameter name change "chip" to "gc"
in gpiochip_add_data function.

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
Link: https://lore.kernel.org/r/20200723095658.234668-1-colton.w.lewis@protonmail.com
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

authored by

Colton Lewis and committed by
Linus Walleij
8fc3ed3a 4530a840

+4 -4
+4 -4
include/linux/gpio/driver.h
··· 497 497 498 498 /** 499 499 * gpiochip_add_data() - register a gpio_chip 500 - * @gc: the chip to register, with chip->base initialized 500 + * @gc: the chip to register, with gc->base initialized 501 501 * @data: driver-private data associated with this chip 502 502 * 503 503 * Context: potentially before irqs will work 504 504 * 505 505 * When gpiochip_add_data() is called very early during boot, so that GPIOs 506 - * can be freely used, the chip->parent device must be registered before 506 + * can be freely used, the gc->parent device must be registered before 507 507 * the gpio framework's arch_initcall(). Otherwise sysfs initialization 508 508 * for GPIOs will fail rudely. 509 509 * 510 510 * gpiochip_add_data() must only be called after gpiolib initialization, 511 511 * ie after core_initcall(). 512 512 * 513 - * If chip->base is negative, this requests dynamic assignment of 513 + * If gc->base is negative, this requests dynamic assignment of 514 514 * a range of valid GPIOs. 515 515 * 516 516 * Returns: 517 517 * A negative errno if the chip can't be registered, such as because the 518 - * chip->base is invalid or already associated with a different chip. 518 + * gc->base is invalid or already associated with a different chip. 519 519 * Otherwise it returns zero as a success code. 520 520 */ 521 521 #ifdef CONFIG_LOCKDEP