PCI: iproc: Fix a non-compliant kernel-doc
PATCH 1/1 PCI: iproc: Fix a non-compliant kernel-doc
Correct a non-compliant kernel-doc at the top of the pcie-iproc-mci.c file, and resolve build time warning related to kernel-doc:
drivers/pci/controller/pcie-iproc-msi.c:52: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc-msi.c:68: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
No change to functionality intended.
--- drivers/pci/controller/pcie-iproc-msi.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
drivers/pci/controller/pcie-iproc-msi.c +8 -8
@@ -49,14 +49,14 @@ enum iproc_msi_reg {struct iproc_msi ;/** -* iProc MSI group -* -* One MSI group is allocated per GIC interrupt, serviced by one iProc MSI -* event queue. +* struct iproc_msi_grp - iProc MSI group * * @msi: pointer to iProc MSI data * @gic_irq: GIC interrupt * @eq: Event queue number +* +* One MSI group is allocated per GIC interrupt, serviced by one iProc MSI +* event queue. */ struct iproc_msi_grp {struct iproc_msi *msi;
@@ -65,10 +65,7 @@ struct iproc_msi_grp { };/** -* iProc event queue based MSI -* -* Only meant to be used on platforms without MSI support integrated into the -* GIC. +* struct iproc_msi - iProc event queue based MSI * * @pcie: pointer to iProc PCIe data * @reg_offsets: MSI register offsets
@@ -89,6 +86,9 @@ struct iproc_msi_grp {* @eq_cpu: pointer to allocated memory region for MSI event queues * @eq_dma: DMA address of MSI event queues * @msi_addr: MSI address +* +* Only meant to be used on platforms without MSI support integrated into the +* GIC. */ struct iproc_msi {struct iproc_pcie *pcie;
Signature · 1 line
2.31.1
Quoted 9 lines · Krzysztof Wilczyński
Correct a non-compliant kernel-doc at the top of the
pcie-iproc-mci.cfile, and resolve build time warning related to kernel-doc:
drivers/pci/controller/pcie-iproc-msi.c:52: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstdrivers/pci/controller/pcie-iproc-msi.c:68: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstNo change to functionality intended.
Signed-off-by Krzysztof Wilczyński <[email protected]>
Thanks.
Quoted 50 lines
--- drivers/pci/controller/pcie-iproc-msi.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)drivers/pci/controller/pcie-iproc-msi.c +8
-8@@ -49,14 +49,14 @@ enum iproc_msi_reg {struct iproc_msi ;/** -* iProc MSI group -* -* One MSI group is allocated per GIC interrupt, serviced by one iProc MSI -* event queue. +* struct iproc_msi_grp - iProc MSI group * * @msi: pointer to iProc MSI data * @gic_irq: GIC interrupt * @eq: Event queue number +* +* One MSI group is allocated per GIC interrupt, serviced by one iProc MSI +* event queue. */ struct iproc_msi_grp {struct iproc_msi *msi;@@ -65,10 +65,7 @@ struct iproc_msi_grp { };/** -* iProc event queue based MSI -* -* Only meant to be used on platforms without MSI support integrated into the -* GIC. +* struct iproc_msi - iProc event queue based MSI * * @pcie: pointer to iProc PCIe data * @reg_offsets: MSI register offsets @@ -89,6 +86,9 @@ struct iproc_msi_grp {* @eq_cpu: pointer to allocated memory region for MSI event queues * @eq_dma: DMA address of MSI event queues * @msi_addr: MSI address +* +* Only meant to be used on platforms without MSI support integrated into the +* GIC. */ struct iproc_msi {struct iproc_pcie *pcie;
Signature · 1 line
~Randy
Hi Randy,
[...]
Quoted 3 lines
Reviewed-by Randy Dunlap <[email protected]>Thanks.
Thank you for the review! I am going to send v2 as I have noticed a few other places where the kernel-doc is not formatted correctly, so that we can resolve all of these at once, hopefully.
Krzysztof