[PATCH] dmaengine: qcom: qcom-gpi-dma.h: fix all kernel-doc warnings

Randy Dunlap posted 1 patch 1 month, 2 weeks ago
include/linux/dma/qcom-gpi-dma.h |    5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
[PATCH] dmaengine: qcom: qcom-gpi-dma.h: fix all kernel-doc warnings
Posted by Randy Dunlap 1 month, 2 weeks ago
Add missing enum descriptions and spell one struct member correctly
to avoid kernel-doc warnings:

Warning: include/linux/dma/qcom-gpi-dma.h:15 Enum value 'SPI_TX' not
 described in enum 'spi_transfer_cmd'
Warning: include/linux/dma/qcom-gpi-dma.h:15 Enum value 'SPI_RX' not
 described in enum 'spi_transfer_cmd'
Warning: include/linux/dma/qcom-gpi-dma.h:15 Enum value 'SPI_DUPLEX' not
 described in enum 'spi_transfer_cmd'
Warning: include/linux/dma/qcom-gpi-dma.h:80 struct member 'multi_msg' not
 described in 'gpi_i2c_config'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Vinod Koul <vkoul@kernel.org>
Cc: Frank Li <Frank.Li@kernel.org>
Cc: dmaengine@vger.kernel.org

 include/linux/dma/qcom-gpi-dma.h |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

--- linux-next-20260227.orig/include/linux/dma/qcom-gpi-dma.h
+++ linux-next-20260227/include/linux/dma/qcom-gpi-dma.h
@@ -8,6 +8,9 @@
 
 /**
  * enum spi_transfer_cmd - spi transfer commands
+ * @SPI_TX: SPI peripheral TX command
+ * @SPI_RX: SPI peripheral RX command
+ * @SPI_DUPLEX: SPI peripheral Duplex command
  */
 enum spi_transfer_cmd {
 	SPI_TX = 1,
@@ -64,7 +67,7 @@ enum i2c_op {
  * @set_config: set peripheral config
  * @rx_len: receive length for buffer
  * @op: i2c cmd
- * @muli-msg: is part of multi i2c r-w msgs
+ * @multi_msg: is part of multi i2c r-w msgs
  */
 struct gpi_i2c_config {
 	u8 set_config;
Re: [PATCH] dmaengine: qcom: qcom-gpi-dma.h: fix all kernel-doc warnings
Posted by Vinod Koul 1 month, 1 week ago
On Sat, 28 Feb 2026 17:12:03 -0800, Randy Dunlap wrote:
> Add missing enum descriptions and spell one struct member correctly
> to avoid kernel-doc warnings:
> 
> Warning: include/linux/dma/qcom-gpi-dma.h:15 Enum value 'SPI_TX' not
>  described in enum 'spi_transfer_cmd'
> Warning: include/linux/dma/qcom-gpi-dma.h:15 Enum value 'SPI_RX' not
>  described in enum 'spi_transfer_cmd'
> Warning: include/linux/dma/qcom-gpi-dma.h:15 Enum value 'SPI_DUPLEX' not
>  described in enum 'spi_transfer_cmd'
> Warning: include/linux/dma/qcom-gpi-dma.h:80 struct member 'multi_msg' not
>  described in 'gpi_i2c_config'
> 
> [...]

Applied, thanks!

[1/1] dmaengine: qcom: qcom-gpi-dma.h: fix all kernel-doc warnings
      commit: 7b84a00dd3528d980f1f35fd2c5015f72dc3f62a

Best regards,
-- 
~Vinod