From: Vinod <vkoul@kernel.org>
To: Robin Gong <yibin.gong@nxp.com>
Cc: dan.j.williams@intel.com, dmaengine@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-imx@nxp.com
Subject: Re: [PATCH v1] dmaengine: imx-sdma: add structure description to eliminate build warning with 'W=1'
Date: Tue, 3 Jul 2018 15:52:05 +0530 [thread overview]
Message-ID: <20180703102205.GP22377@vkoul-mobl> (raw)
In-Reply-To: <1530640175-3478-1-git-send-email-yibin.gong@nxp.com>
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@nxp.com>
> Reported-by: Vinod Koul <vkoul@kernel.org>
> Signed-off-by: Robin Gong <yibin.gong@nxp.com>
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
prev parent reply other threads:[~2018-07-03 10:22 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-03 17:49 [PATCH v1] dmaengine: imx-sdma: add structure description to eliminate build warning with 'W=1' Robin Gong
2018-07-03 10:22 ` Vinod [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180703102205.GP22377@vkoul-mobl \
--to=vkoul@kernel.org \
--cc=dan.j.williams@intel.com \
--cc=dmaengine@vger.kernel.org \
--cc=linux-imx@nxp.com \
--cc=linux-kernel@vger.kernel.org \
--cc=yibin.gong@nxp.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).