PCI: Fix kernel-doc issues
PATCH 1/1 PCI: Fix kernel-doc issues
From: Bjorn Helgaas <[email protected]>
Fix kernel-doc issues reported by
"find include -name \*pci\* | xargs scripts/kernel-doc -none":
include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga' include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc' include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead
--- include/linux/pci-epc.h | 2 +- include/linux/pci-epf.h | 2 +- include/linux/pci.h | 1 + 3 files changed, 3 insertions(+), 2 deletions(-)
include/linux/pci-epc.h +1 -1
@@ -122,7 +122,7 @@ struct pci_epc_mem {* struct pci_epc - represents the PCI EPC device * @dev: PCI EPC device * @pci_epf: list of endpoint functions present in this EPC device -* list_lock: Mutex for protecting pci_epf list +* @list_lock: Mutex for protecting pci_epf list * @ops: function pointers for performing endpoint operations * @windows: array of address space of the endpoint controller * @mem: first window of the endpoint controller, which corresponds to
include/linux/pci-epf.h +1 -1
@@ -68,7 +68,7 @@ struct pci_epf_ops { };/** -* struct pci_epf_event_ops - Callbacks for capturing the EPC events +* struct pci_epc_event_ops - Callbacks for capturing the EPC events * @core_init: Callback for the EPC initialization complete event * @link_up: Callback for the EPC link up event * @link_down: Callback for the EPC link down event
include/linux/pci.h +1 -0
@@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev)/** * pci_is_vga - check if the PCI device is a VGA device +* @pdev: PCI device * * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define * VGA Base Class and Sub-Classes:
Signature · 1 line
2.34.1
Quoted 10 lines · Bjorn Helgaas
From: Bjorn Helgaas <[email protected]>
Fix kernel-doc issues reported by
"find include -name \*pci\* | xargsscripts/kernel-doc-none":
include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga'include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc'include/linux/pci-epf.h:83: warning: expecting prototype for structpci_epf_event_ops. Prototype was for structpci_epc_event_opsinsteadSigned-off-by Bjorn Helgaas <[email protected]>
Thanks.
Quoted 44 lines
--- include/linux/pci-epc.h | 2 +- include/linux/pci-epf.h | 2 +- include/linux/pci.h | 1 + 3 files changed, 3 insertions(+), 2 deletions(-)include/linux/pci-epc.h +1
-1@@ -122,7 +122,7 @@ struct pci_epc_mem {* struct pci_epc - represents the PCI EPC device * @dev: PCI EPC device * @pci_epf: list of endpoint functions present in this EPC device -* list_lock: Mutex for protecting pci_epf list +* @list_lock: Mutex for protecting pci_epf list * @ops: function pointers for performing endpoint operations * @windows: array of address space of the endpoint controller * @mem: first window of the endpoint controller, which corresponds to include/linux/pci-epf.h +1
-1@@ -68,7 +68,7 @@ struct pci_epf_ops { };/** -* struct pci_epf_event_ops - Callbacks for capturing the EPC events +* struct pci_epc_event_ops - Callbacks for capturing the EPC events * @core_init: Callback for the EPC initialization complete event * @link_up: Callback for the EPC link up event * @link_down: Callback for the EPC link down event include/linux/pci.h +1
-0@@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev)/** * pci_is_vga - check if the PCI device is a VGA device +* @pdev: PCI device * * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define * VGA Base Class and Sub-Classes:
Signature · 1 line
#Randy
Hi,
Quoted 8 lines · Bjorn Helgaas
From: Bjorn Helgaas <[email protected]>
Fix kernel-doc issues reported by
"find include -name \*pci\* | xargsscripts/kernel-doc-none":
include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga'include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc'include/linux/pci-epf.h:83: warning: expecting prototype for structpci_epf_event_ops. Prototype was for structpci_epc_event_opsinstead
Thanks a lot for the fix.
Quoted 1 line
Signed-off-by Bjorn Helgaas <[email protected]>
Quoted 10 lines · Bjorn Helgaas
From: Bjorn Helgaas <[email protected]>
Fix kernel-doc issues reported by
"find include -name \*pci\* | xargsscripts/kernel-doc-none":
include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga'include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc'include/linux/pci-epf.h:83: warning: expecting prototype for structpci_epf_event_ops. Prototype was for structpci_epc_event_opsinsteadSigned-off-by Bjorn Helgaas <[email protected]>
- Mani
Quoted 48 lines
--- include/linux/pci-epc.h | 2 +- include/linux/pci-epf.h | 2 +- include/linux/pci.h | 1 + 3 files changed, 3 insertions(+), 2 deletions(-)include/linux/pci-epc.h +1
-1@@ -122,7 +122,7 @@ struct pci_epc_mem {* struct pci_epc - represents the PCI EPC device * @dev: PCI EPC device * @pci_epf: list of endpoint functions present in this EPC device -* list_lock: Mutex for protecting pci_epf list +* @list_lock: Mutex for protecting pci_epf list * @ops: function pointers for performing endpoint operations * @windows: array of address space of the endpoint controller * @mem: first window of the endpoint controller, which corresponds to include/linux/pci-epf.h +1
-1@@ -68,7 +68,7 @@ struct pci_epf_ops { };/** -* struct pci_epf_event_ops - Callbacks for capturing the EPC events +* struct pci_epc_event_ops - Callbacks for capturing the EPC events * @core_init: Callback for the EPC initialization complete event * @link_up: Callback for the EPC link up event * @link_down: Callback for the EPC link down event include/linux/pci.h +1
-0@@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev)/** * pci_is_vga - check if the PCI device is a VGA device +* @pdev: PCI device * * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define * VGA Base Class and Sub-Classes: Signature · 1 line
2.34.1
Signature · 1 line
மணிவண்ணன் சதாசிவம்
Quoted 10 lines · Bjorn Helgaas
From: Bjorn Helgaas <[email protected]>
Fix kernel-doc issues reported by
"find include -name \*pci\* | xargsscripts/kernel-doc-none":
include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga'include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc'include/linux/pci-epf.h:83: warning: expecting prototype for structpci_epf_event_ops. Prototype was for structpci_epc_event_opsinsteadSigned-off-by Bjorn Helgaas <[email protected]>
Applied with Randy's Acked-by and Tested-by for v6.8. Thanks for the other replies; I would certainly add them but for the fact that I've already tagged what I intend to ask Linus to pull for v6.8.
Bjorn