[PATCH] PCI: iproc: Fix a non-compliant kernel-doc

[PATCH] PCI: iproc: Fix a non-compliant kernel-doc

[Krzysztof Wilczyński]

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.

Signed-off-by: Krzysztof Wilczyński <kw@linux.com>
---
 drivers/pci/controller/pcie-iproc-msi.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/pci/controller/pcie-iproc-msi.c b/drivers/pci/controller/pcie-iproc-msi.c
index eede4e8f3f75..65ea83d2abfa 100644
--- a/drivers/pci/controller/pcie-iproc-msi.c
+++ b/drivers/pci/controller/pcie-iproc-msi.c
@@ -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;
-- 
2.31.1


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Re: [PATCH] PCI: iproc: Fix a non-compliant kernel-doc

[Randy Dunlap]

On 5/19/21 10:35 AM, Krzysztof Wilczyński wrote:
> 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.
> 
> Signed-off-by: Krzysztof Wilczyński <kw@linux.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/pci/controller/pcie-iproc-msi.c | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/pci/controller/pcie-iproc-msi.c b/drivers/pci/controller/pcie-iproc-msi.c
> index eede4e8f3f75..65ea83d2abfa 100644
> --- a/drivers/pci/controller/pcie-iproc-msi.c
> +++ b/drivers/pci/controller/pcie-iproc-msi.c
> @@ -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;
> 


-- 
~Randy


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Re: [PATCH] PCI: iproc: Fix a non-compliant kernel-doc

[Krzysztof Wilczyński]

Hi Randy,

[...]
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> 
> 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

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel