From: Lee Jones <lee.jones@linaro.org>
To: dan.j.williams@intel.com, vkoul@kernel.org
Cc: linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org, dmaengine@vger.kernel.org,
Lee Jones <lee.jones@linaro.org>,
Sean Wang <sean.wang@mediatek.com>,
Matthias Brugger <matthias.bgg@gmail.com>,
linux-mediatek@lists.infradead.org
Subject: [PATCH 01/17] dma: mediatek: mtk-hsdma: Fix formatting in 'struct mtk_hsdma_pdesc' doc block
Date: Tue, 14 Jul 2020 12:15:30 +0100 [thread overview]
Message-ID: <20200714111546.1755231-2-lee.jones@linaro.org> (raw)
In-Reply-To: <20200714111546.1755231-1-lee.jones@linaro.org>
Struct attribute names must be an exact match or the kerneldoc checker
gets confused.
Fixes the following W=1 kernel build warning(s):
drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc1' not described in 'mtk_hsdma_pdesc'
drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc2' not described in 'mtk_hsdma_pdesc'
drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc3' not described in 'mtk_hsdma_pdesc'
drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc4' not described in 'mtk_hsdma_pdesc'
Cc: Sean Wang <sean.wang@mediatek.com>
Cc: Matthias Brugger <matthias.bgg@gmail.com>
Cc: linux-mediatek@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/dma/mediatek/mtk-hsdma.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/drivers/dma/mediatek/mtk-hsdma.c b/drivers/dma/mediatek/mtk-hsdma.c
index 4c58da7421432..f133ae8dece16 100644
--- a/drivers/dma/mediatek/mtk-hsdma.c
+++ b/drivers/dma/mediatek/mtk-hsdma.c
@@ -107,10 +107,10 @@ enum mtk_hsdma_vdesc_flag {
* struct mtk_hsdma_pdesc - This is the struct holding info describing physical
* descriptor (PD) and its placement must be kept at
* 4-bytes alignment in little endian order.
- * @desc[1-4]: The control pad used to indicate hardware how to
- * deal with the descriptor such as source and
- * destination address and data length. The maximum
- * data length each pdesc can handle is 0x3f80 bytes
+ * @desc1: | The control pad used to indicate hardware how to
+ * @desc2: | deal with the descriptor such as source and
+ * @desc3: | destination address and data length. The maximum
+ * @desc4: | data length each pdesc can handle is 0x3f80 bytes
*/
struct mtk_hsdma_pdesc {
__le32 desc1;
--
2.25.1
next prev parent reply other threads:[~2020-07-14 11:16 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-14 11:15 [PATCH 00/17] Rid W=1 warnings in DMA Lee Jones
2020-07-14 11:15 ` Lee Jones [this message]
2020-07-14 11:15 ` [PATCH 02/17] dma: of-dma: Fix misspellings/formatting issues in some function headers Lee Jones
2020-07-14 11:15 ` [PATCH 03/17] dma: ep93xx_dma: Provide some missing struct attribute documentation Lee Jones
2020-07-14 11:15 ` [PATCH 04/17] dma: mmp_pdma: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-14 11:15 ` [PATCH 05/17] dma: pl330: Demote obvious misuse of kerneldoc to standard comment block Lee Jones
2020-07-14 11:15 ` [PATCH 06/17] dma: ste_dma40: Supply 2 missing struct attribute descriptions Lee Jones
2020-07-14 11:15 ` [PATCH 07/17] dma: altera-msgdma: Fix struct documentation blocks Lee Jones
2020-07-16 7:04 ` Stefan Roese
2020-07-14 11:15 ` [PATCH 08/17] dma: at_hdmac: Repair parameter misspelling and demote non-kerneldoc headers Lee Jones
2020-07-14 11:15 ` [PATCH 09/17] dma: sun4i-dma: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-15 2:54 ` Chen-Yu Tsai
2020-07-14 11:15 ` [PATCH 10/17] dma: fsl-qdma: Fix 'struct fsl_qdma_format' formatting issue Lee Jones
2020-07-14 11:15 ` [PATCH 11/17] dma: imx-sdma: Correct formatting issue and provide 2 new descriptions Lee Jones
2020-07-14 11:15 ` [PATCH 12/17] dma: iop-adma: Function parameter documentation must adhere to correct formatting Lee Jones
2020-07-14 11:15 ` [PATCH 13/17] dma: nbpfaxi: Provide some missing attribute docs and split out slave info Lee Jones
2020-07-14 11:15 ` [PATCH 14/17] dma: xgene-dma: Provide descriptions for 'dev' and 'clk' in device's ddata Lee Jones
2020-07-14 11:15 ` [PATCH 15/17] dma: mv_xor_v2: Supply some missing 'struct mv_xor_v2_device' attribute docs Lee Jones
2020-07-14 11:15 ` [PATCH 16/17] dma: ioat: init: Correct misspelling of function parameter 'c' for channel Lee Jones
2020-07-14 11:15 ` [PATCH 17/17] dma: ioat: dma: Fix some parameter misspelling and provide description for phys_complete Lee Jones
2020-07-15 15:29 ` [PATCH 00/17] Rid W=1 warnings in DMA Vinod Koul
2020-07-15 15:37 ` Lee Jones
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=20200714111546.1755231-2-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=dan.j.williams@intel.com \
--cc=dmaengine@vger.kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mediatek@lists.infradead.org \
--cc=matthias.bgg@gmail.com \
--cc=sean.wang@mediatek.com \
--cc=vkoul@kernel.org \
/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).