[PATCH RESEND] dmaengine: Fix dma_async_tx_descriptor->tx_submit documentation

[PATCH RESEND] dmaengine: Fix dma_async_tx_descriptor->tx_submit documentation

[Nathan Lynch via B4 Relay]

From: Nathan Lynch <nathan.lynch@amd.com>

Commit 790fb9956eea ("linux/dmaengine.h: fix a few kernel-doc
warnings") inserted new documentation for @desc_free in the middle of
@tx_submit's description.

Put @tx_submit's description back together, matching the indentation
style of the rest of the documentation for dma_async_tx_descriptor.

Fixes: 790fb9956eea ("linux/dmaengine.h: fix a few kernel-doc warnings")
Reviewed-by: Dave Jiang <dave.jiang@intel.com>
Signed-off-by: Nathan Lynch <nathan.lynch@amd.com>
---
Originally sent 12 Mar 2025:
https://lore.kernel.org/dmaengine/20250312-dma_async_tx_desc-tx_submit-doc-v1-1-16390060264c@amd.com/
---
 include/linux/dmaengine.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/dmaengine.h b/include/linux/dmaengine.h
index 6de7c05d6bd8c99e176fe2fde0a9c3b55d40b37c..99efe2b9b4ea9844ca6161208362ef18ef111d96 100644
--- a/include/linux/dmaengine.h
+++ b/include/linux/dmaengine.h
@@ -594,9 +594,9 @@ struct dma_descriptor_metadata_ops {
  * @phys: physical address of the descriptor
  * @chan: target channel for this operation
  * @tx_submit: accept the descriptor, assign ordered cookie and mark the
+ *	descriptor pending. To be pushed on .issue_pending() call
  * @desc_free: driver's callback function to free a resusable descriptor
  *	after completion
- * descriptor pending. To be pushed on .issue_pending() call
  * @callback: routine to call after this operation is complete
  * @callback_result: error result from a DMA transaction
  * @callback_param: general parameter to pass to the callback routine

---
base-commit: 8f5ae30d69d7543eee0d70083daf4de8fe15d585
change-id: 20250826-dma_async_tx_desc-tx_submit-doc-fix-3b8d8b6f4dc3

Best regards,
-- 
Nathan Lynch <nathan.lynch@amd.com>

Re: [PATCH RESEND] dmaengine: Fix dma_async_tx_descriptor->tx_submit documentation

[Vinod Koul]

On Tue, 26 Aug 2025 11:07:38 -0500, Nathan Lynch wrote:
> Commit 790fb9956eea ("linux/dmaengine.h: fix a few kernel-doc
> warnings") inserted new documentation for @desc_free in the middle of
> @tx_submit's description.
> 
> Put @tx_submit's description back together, matching the indentation
> style of the rest of the documentation for dma_async_tx_descriptor.
> 
> [...]

Applied, thanks!

[1/1] dmaengine: Fix dma_async_tx_descriptor->tx_submit documentation
      commit: 7ea95d55e63176899eb96f7aaa34a5646f501b2c

Best regards,
-- 
~Vinod