Message ID | 20180403145225.22371-8-mika.westerberg@linux.intel.com (mailing list archive) |
---|---|
State | New, archived |
Delegated to: | Bjorn Helgaas |
Headers | show |
On Tuesday, April 3, 2018 4:52:23 PM CEST Mika Westerberg wrote: > It is not immediately clear what the two functions actually return so > add kernel-doc comment explaining it a bit better. > > Suggested-by: Bjorn Helgaas <bhelgaas@google.com> > Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com> > --- > drivers/pci/probe.c | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/drivers/pci/probe.c b/drivers/pci/probe.c > index 8c4715df62e7..079eea6680bb 100644 > --- a/drivers/pci/probe.c > +++ b/drivers/pci/probe.c > @@ -983,6 +983,8 @@ static unsigned int pci_scan_child_bus_extend(struct pci_bus *bus, > * already configured by the BIOS and after we are done with all of > * them, we proceed to assigning numbers to the remaining buses in > * order to avoid overlaps between old and new bus numbers. > + * > + * Return: New subordinate number covering all buses behind this bridge. > */ > static int pci_scan_bridge_extend(struct pci_bus *bus, struct pci_dev *dev, > int max, unsigned int available_buses, > @@ -1215,6 +1217,8 @@ static int pci_scan_bridge_extend(struct pci_bus *bus, struct pci_dev *dev, > * already configured by the BIOS and after we are done with all of > * them, we proceed to assigning numbers to the remaining buses in > * order to avoid overlaps between old and new bus numbers. > + * > + * Return: New subordinate number covering all buses behind this bridge. > */ > int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max, int pass) > { > Reviewed-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
diff --git a/drivers/pci/probe.c b/drivers/pci/probe.c index 8c4715df62e7..079eea6680bb 100644 --- a/drivers/pci/probe.c +++ b/drivers/pci/probe.c @@ -983,6 +983,8 @@ static unsigned int pci_scan_child_bus_extend(struct pci_bus *bus, * already configured by the BIOS and after we are done with all of * them, we proceed to assigning numbers to the remaining buses in * order to avoid overlaps between old and new bus numbers. + * + * Return: New subordinate number covering all buses behind this bridge. */ static int pci_scan_bridge_extend(struct pci_bus *bus, struct pci_dev *dev, int max, unsigned int available_buses, @@ -1215,6 +1217,8 @@ static int pci_scan_bridge_extend(struct pci_bus *bus, struct pci_dev *dev, * already configured by the BIOS and after we are done with all of * them, we proceed to assigning numbers to the remaining buses in * order to avoid overlaps between old and new bus numbers. + * + * Return: New subordinate number covering all buses behind this bridge. */ int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max, int pass) {
It is not immediately clear what the two functions actually return so add kernel-doc comment explaining it a bit better. Suggested-by: Bjorn Helgaas <bhelgaas@google.com> Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com> --- drivers/pci/probe.c | 4 ++++ 1 file changed, 4 insertions(+)