PCI: endpoint: Fix kernel-doc formatting and add missing documentation
PATCH 1/1 PCI: endpoint: Fix kernel-doc formatting and add missing documentation
Fix kernel-doc formatting and add missing documentation for the members "barno" and "flags" of the struct pci_epf_bar, "msix_interrupts" of the struct pci_epf, "get_features" of the struct pci_epc_ops and "core_init_notifier" of the struct pci_epc_features.
Thus, resolve build time warnings related to kernel-doc:
include/linux/pci-epf.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst include/linux/pci-epf.h:113: warning: Function parameter or member 'barno' not described in 'pci_epf_bar' include/linux/pci-epf.h:113: warning: Function parameter or member 'flags' not described in 'pci_epf_bar' include/linux/pci-epf.h:157: warning: Function parameter or member 'msix_interrupts' not described in 'pci_epf'
include/linux/pci-ep-cfs.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
include/linux/pci-epc.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst include/linux/pci-epc.h:91: warning: Function parameter or member 'get_features' not described in 'pci_epc_ops' include/linux/pci-epc.h:170: warning: Function parameter or member 'core_init_notifier' not described in 'pci_epc_features'
No change to functionality intended.
--- include/linux/pci-ep-cfs.h | 2 +- include/linux/pci-epc.h | 62 +++++++++++++++++++++----------------- include/linux/pci-epf.h | 56 ++++++++++++++++++++-------------- 3 files changed, 68 insertions(+), 52 deletions(-)
include/linux/pci-ep-cfs.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0+ */ -/** +/* * PCI Endpoint ConfigFS header file * * Copyright (C) 2017 Texas Instruments
include/linux/pci-epc.h +34 -28
78 lines not on this page · raw message
include/linux/pci-epf.h +33 -23
72 lines not on this page · raw message
Signature · 1 line
2.32.0
Hi Bjorn,
This patch has been superseded by the following series:
https://lore.kernel.org/linux-pci/[email protected]/T/
Krzysztof