Re: [PATCH v1] dmaengine: imx-sdma: add structure description to eliminate build warning with 'W=1'

[Vinod]

Hey Robin,

On 04-07-18, 01:49, Robin Gong wrote:

No need to mention W=1 is patch title. Title should only describe the
change being done, so "add missing structure description" would suffice.

> Some member description or colons miss cause build warning with 'W=1'
> as below:
> 
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'vd' not described in 'sdma_desc'
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'num_bd' not described in 'sdma_desc'
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'bd_phys' not described in 'sdma_desc'
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_tail' not described in 'sdma_desc'
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'buf_ptail' not described in 'sdma_desc'
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'period_len' not described in 'sdma_desc'
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'chn_real_count' not described in 'sdma_desc'
> drivers/dma/imx-sdma.c:326: warning: Function parameter or member 'chn_count' not described in 'sdma_desc
> 
> Signed-off-by: Robin Gong <yibin.gong@xxxxxxx>
> Reported-by: Vinod Koul <vkoul@xxxxxxxxxx>
> Signed-off-by: Robin Gong <yibin.gong@xxxxxxx>

No need for your s-o-b twice, once is enough

>  /**
>   * struct sdma_desc - descriptor structor for one transfer

s/structor/structure

> - * @vd			descriptor for virt dma
> - * @num_bd		max NUM_BD. number of descriptors currently handling
> - * @buf_tail		ID of the buffer that was processed
> - * @buf_ptail		ID of the previous buffer that was processed
> - * @period_len		period length, used in cyclic.
> - * @chn_real_count	the real count updated from bd->mode.count
> - * @chn_count		the transfer count set
> - * @sdmac		sdma_channel pointer
> - * @bd			pointer of allocate bd
> + * @vd:			descriptor for virt dma
> + * @num_bd:		max NUM_BD. number of descriptors currently handling

Number (title case)
-- 
~Vinod