Subject: Re: linux-next: build warning after merge of the pci-current tree

From: Johan Hovold <[email-masked]>
Date: Wed, 31 Jan 2024 08:42:41 +0100

On Wed, Jan 31, 2024 at 12:58:43PM +1100, Stephen Rothwell wrote:
> Hi all,
> 
> After merging the pci-current tree, today's linux-next build (htmldocs)
> produced this warning:
> 
> drivers/pci/bus.c:440: warning: Function parameter or struct member 'top' not described in 'pci_walk_bus'
> drivers/pci/bus.c:440: warning: Function parameter or struct member 'cb' not described in 'pci_walk_bus'
> drivers/pci/bus.c:440: warning: Function parameter or struct member 'userdata' not described in 'pci_walk_bus'
> 
> Introduced by commit
> 
>   69fb843fdbd9 ("PCI/ASPM: Fix deadlock when enabling ASPM")

Bah, I added a newline after the opening /** when moving a comment
without noticing that the kernel doc comment was malformed.

Bjorn, you could either remove that newline or squash the below patch
address this.

Johan

diff --git a/drivers/pci/bus.c b/drivers/pci/bus.c
index 116415f91195..826b5016a101 100644
--- a/drivers/pci/bus.c
+++ b/drivers/pci/bus.c
@@ -425,9 +425,9 @@ static void __pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void
 
 /**
  *  pci_walk_bus - walk devices on/under bus, calling callback.
- *  @top      bus whose devices should be walked
- *  @cb       callback to be called for each device found
- *  @userdata arbitrary pointer to be passed to callback.
+ *  @top: bus whose devices should be walked
+ *  @cb: callback to be called for each device found
+ *  @userdata: arbitrary pointer to be passed to callback
  *
  *  Walk the given bus, including any bridged devices
  *  on buses under this bus.  Call the provided callback