diff mbox series

[net-next] driver core: auxiliary bus: Fix documentation of auxiliary_device

Message ID 20240717172916.595808-1-saeed@kernel.org (mailing list archive)
State Accepted
Commit c14112a5574ff5cf3de198ab6eeff53ac1234068
Delegated to: Netdev Maintainers
Headers show
Series [net-next] driver core: auxiliary bus: Fix documentation of auxiliary_device | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 661 this patch: 661
netdev/build_tools success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers fail 2 blamed authors not CCed: gregkh@linuxfoundation.org przemyslaw.kitszel@intel.com; 4 maintainers not CCed: ira.weiny@intel.com david.m.ertman@intel.com gregkh@linuxfoundation.org przemyslaw.kitszel@intel.com
netdev/build_clang success Errors and warnings before: 662 this patch: 662
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 682 this patch: 682
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 13 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 4 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest fail net-next-2024-07-18--00-00 (tests: 699)

Commit Message

Saeed Mahameed July 17, 2024, 5:29 p.m. UTC 
From: Shay Drory <shayd@nvidia.com>

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")
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>
---
 include/linux/auxiliary_bus.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Jakub Kicinski July 18, 2024, 12:02 a.m. UTC | #1 
On Wed, 17 Jul 2024 10:29:16 -0700 Saeed Mahameed wrote:
> From: Shay Drory <shayd@nvidia.com>
> 
> 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")
> 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>

Thanks!

Greg, please let us know if you'd like to handle this yourself.
Otherwise we'll ship it to Linus tomorrow or Friday.
Greg KH July 18, 2024, 4:55 a.m. UTC | #2 
On Wed, Jul 17, 2024 at 05:02:54PM -0700, Jakub Kicinski wrote:
> On Wed, 17 Jul 2024 10:29:16 -0700 Saeed Mahameed wrote:
> > From: Shay Drory <shayd@nvidia.com>
> > 
> > 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")
> > 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>
> 
> Thanks!
> 
> Greg, please let us know if you'd like to handle this yourself.

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

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

Please do so.

thanks,

greg k-h
patchwork-bot+netdevbpf@kernel.org July 18, 2024, 5:30 a.m. UTC | #3 
Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Wed, 17 Jul 2024 10:29:16 -0700 you wrote:
> From: Shay Drory <shayd@nvidia.com>
> 
> 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!
diff mbox series

Patch

diff --git a/include/linux/auxiliary_bus.h b/include/linux/auxiliary_bus.h
index 3ba4487c9cd9..1539bbd263d2 100644
--- a/include/linux/auxiliary_bus.h
+++ b/include/linux/auxiliary_bus.h
@@ -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