[PATCH] dmaengine: fsl-edma: fix all kernel-doc warnings

Randy Dunlap posted 1 patch 1 month, 1 week ago
include/linux/platform_data/dma-mcf-edma.h |    5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
[PATCH] dmaengine: fsl-edma: fix all kernel-doc warnings
Posted by Randy Dunlap 1 month, 1 week ago
Use the correct kernel-doc format and struct member names to eliminate
these kernel-doc warnings:

Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
 'dma_channels' not described in 'mcf_edma_platform_data'
Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
 'slave_map' not described in 'mcf_edma_platform_data'
Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
 'slavecnt' not described in 'mcf_edma_platform_data'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Frank Li <Frank.Li@nxp.com>
Cc: imx@lists.linux.dev
Cc: dmaengine@vger.kernel.org
Cc: Vinod Koul <vkoul@kernel.org>

 include/linux/platform_data/dma-mcf-edma.h |    5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

--- linux-next-20260225.orig/include/linux/platform_data/dma-mcf-edma.h
+++ linux-next-20260225/include/linux/platform_data/dma-mcf-edma.h
@@ -26,8 +26,9 @@ bool mcf_edma_filter_fn(struct dma_chan
 /**
  * struct mcf_edma_platform_data - platform specific data for eDMA engine
  *
- * @ver			The eDMA module version.
- * @dma_channels	The number of eDMA channels.
+ * @dma_channels:	The number of eDMA channels.
+ * @slave_map:		Slave device map
+ * @slavecnt:		Number of entries in @slave_map
  */
 struct mcf_edma_platform_data {
 	int dma_channels;
Re: [PATCH] dmaengine: fsl-edma: fix all kernel-doc warnings
Posted by Vinod Koul 1 month, 1 week ago
On Wed, 25 Feb 2026 21:12:20 -0800, Randy Dunlap wrote:
> Use the correct kernel-doc format and struct member names to eliminate
> these kernel-doc warnings:
> 
> Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
>  'dma_channels' not described in 'mcf_edma_platform_data'
> Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
>  'slave_map' not described in 'mcf_edma_platform_data'
> Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
>  'slavecnt' not described in 'mcf_edma_platform_data'
> 
> [...]

Applied, thanks!

[1/1] dmaengine: fsl-edma: fix all kernel-doc warnings
      commit: c8e9b1d9febc83ee94944695a07cfd40a1b29743

Best regards,
-- 
~Vinod
Re: [PATCH] dmaengine: fsl-edma: fix all kernel-doc warnings
Posted by Frank Li 1 month, 1 week ago
On Wed, Feb 25, 2026 at 09:12:20PM -0800, Randy Dunlap wrote:
> Use the correct kernel-doc format and struct member names to eliminate
> these kernel-doc warnings:
>
> Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
>  'dma_channels' not described in 'mcf_edma_platform_data'
> Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
>  'slave_map' not described in 'mcf_edma_platform_data'
> Warning: include/linux/platform_data/dma-mcf-edma.h:35 struct member
>  'slavecnt' not described in 'mcf_edma_platform_data'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
Reviewed-by: Frank Li <Frank.Li@nxp.com>
> Cc: Frank Li <Frank.Li@nxp.com>
> Cc: imx@lists.linux.dev
> Cc: dmaengine@vger.kernel.org
> Cc: Vinod Koul <vkoul@kernel.org>
>
>  include/linux/platform_data/dma-mcf-edma.h |    5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> --- linux-next-20260225.orig/include/linux/platform_data/dma-mcf-edma.h
> +++ linux-next-20260225/include/linux/platform_data/dma-mcf-edma.h
> @@ -26,8 +26,9 @@ bool mcf_edma_filter_fn(struct dma_chan
>  /**
>   * struct mcf_edma_platform_data - platform specific data for eDMA engine
>   *
> - * @ver			The eDMA module version.
> - * @dma_channels	The number of eDMA channels.
> + * @dma_channels:	The number of eDMA channels.
> + * @slave_map:		Slave device map
> + * @slavecnt:		Number of entries in @slave_map
>   */
>  struct mcf_edma_platform_data {
>  	int dma_channels;