PCI: hotplug: Fix kernel-doc formatting and add missing documentation
PATCH 1/1 PCI: hotplug: Fix kernel-doc formatting and add missing documentation
Fix kernel-doc formatting and add missing documentation for the parameters "bus" of the get_slot_mapping() function and resolve build time warnings related to kernel-doc:
drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'bus' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'bus_num' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'dev_num' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'slot' not described in 'get_slot_mapping'
No change to functionality intended.
--- drivers/pci/hotplug/cpqphp_core.c | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)
drivers/pci/hotplug/cpqphp_core.c +9 -7
@@ -292,15 +292,17 @@ static int ctrl_slot_cleanup(struct controller *ctrl)/** -* get_slot_mapping - determine logical slot mapping for PCI device +* get_slot_mapping - Determine logical slot mapping for PCI device. +* @bus: Pointer to the PCI bus structure. +* @bus_num: Bus number of the PCI device. +* @dev_num: Device number of the PCI device. +* @slot: Pointer to where slot number will be returned. * -* Won't work for more than one PCI-PCI bridge in a slot. +* Will not work for more than one PCI-PCI bridge in a slot. * -* @bus_num - bus number of PCI device -* @dev_num - device number of PCI device -* @slot - Pointer to u8 where slot number will be returned -* -* Output: SUCCESS or FAILURE +* Return: +* * 0 - Logical slot mapping has been found for this PCI device. +* * < 0 - Unable to find entry in the routing table for this PCI device. */ static int get_slot_mapping (struct pci_bus *bus,u8 bus_num,u8 dev_num,u8 *slot)
Signature · 1 line
2.32.0
Hi Bjorn,
I am going to send a v2 of this patch, as I wanted to include more changes to fix issues related to kerne-doc usage within various Hotplug-related files.
Sorry for the commotion!
Krzysztof