Skip to contentSkip to conversation

driver core: auxiliary bus: Fix documentation of auxiliary_device

PATCH Applied Saeed Mahameed 4 participants 4 messages Jul 17, 2024 – Jul 18, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 driver core: auxiliary bus: Fix documentation of auxiliary_device

From: Shay Drory <[email protected]>

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 a808878308a8 ("driver core: auxiliary bus: show auxiliary device IRQs")
---
 include/linux/auxiliary_bus.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
include/linux/auxiliary_bus.h +4 -3
index 3ba4487c9cd9..1539bbd263d2 100644
@@ -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
Signature · 1 line
2.45.2
maintainer
#1 lore raw
Quoted 9 lines · On Wed, 17 Jul 2024 10:29:16 -0700 Saeed Mahameed wrote:

From: Shay Drory <[email protected]>

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'

Quoted 4 lines
Fixes a808878308a8 ("driver core: auxiliary bus: show auxiliary device IRQs")

Thanks!

Greg, please let us know if you'd like to handle this yourself. Otherwise we'll ship it to Linus tomorrow or Friday.

#2 lore raw
Quoted 10 lines · Jakub Kicinski
Quoted 9 lines · On Wed, 17 Jul 2024 10:29:16 -0700 Saeed Mahameed wrote:

From: Shay Drory <[email protected]>

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'

Quoted 8 lines
Quoted 4 lines
Fixes a808878308a8 ("driver core: auxiliary bus: show auxiliary device IRQs")

Thanks!

Greg, please let us know if you'd like to handle this yourself.

I can't, it came in through your tree :)

Quoted 1 line

Otherwise we'll ship it to Linus tomorrow or Friday.

Please do so.

thanks,

greg k-h

#3 lore raw
In reply to Saeed Mahameed
This patch was applied to netdev/net.git (main) by Jakub Kicinski <[email protected]>:

Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <[email protected]>:

Quoted 10 lines · On Wed, 17 Jul 2024 10:29:16 -0700 you wrote:

From: Shay Drory <[email protected]>

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'

[...]

Here is the summary with links:
- [net-next] driver core: auxiliary bus: Fix documentation of auxiliary_device

    https://git.kernel.org/netdev/net/c/c14112a5574f

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html