Commit c14112a5 authored Jul 17, 2024 by Shay Drory Committed by Jakub Kicinski Jul 17, 2024

driver core: auxiliary bus: Fix documentation of auxiliary_device

Fix the documentation of the below field of struct auxiliary_device

include/linux/auxiliary_bus.h:150: warning: Function parameter or struct member 'sysfs' not described in 'auxiliary_device'
include/linux/auxiliary_bus.h:150: warning: Excess struct member 'irqs' description in 'auxiliary_device'
include/linux/auxiliary_bus.h:150: warning: Excess struct member 'lock' description in 'auxiliary_device'
include/linux/auxiliary_bus.h:150: warning: Excess struct member 'irq_dir_exists' description in 'auxiliary_device'

Fixes: a8088783 ("driver core: auxiliary bus: show auxiliary device IRQs")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Shay Drory <shayd@nvidia.com>
Signed-off-by: Saeed Mahameed <saeedm@nvidia.com>
Link: https://patch.msgid.link/20240717172916.595808-1-saeed@kernel.org

Signed-off-by: Jakub Kicinski <kuba@kernel.org>

parent 1f038d58

include/linux/auxiliary_bus.h

+4 −3

Original line number	Diff line number	Diff line
		@@ -58,9 +58,10 @@
		* in
		* @name: Match name found by the auxiliary device driver,
		* @id: unique identitier if multiple devices of the same name are exported,
		* @irqs: irqs xarray contains irq indices which are used by the device,
		* @lock: Synchronize irq sysfs creation,
		* @irq_dir_exists: whether "irqs" directory exists,
		* @sysfs: embedded struct which hold all sysfs related fields,
		* @sysfs.irqs: irqs xarray contains irq indices which are used by the device,
		* @sysfs.lock: Synchronize irq sysfs creation,
		* @sysfs.irq_dir_exists: whether "irqs" directory exists,
		*
		* An auxiliary_device represents a part of its parent device's functionality.
		* It is given a name that, combined with the registering drivers