[PATCH] dmaengine: Fix dma_async_tx_descriptor->tx_submit documentation

[PATCH] 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")
Signed-off-by: Nathan Lynch <nathan.lynch@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 bb146c5ac3e4ccd7bc0afbf3b28e5b3d659ad62f..51e1e357892a0325646f82d580b199321d59ced4 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: 6565439894570a07b00dba0b739729fe6b56fba4
change-id: 20250312-dma_async_tx_desc-tx_submit-doc-58a4cfee2e8b

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

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

[Dave Jiang]

On 3/12/25 8:32 AM, Nathan Lynch via B4 Relay wrote:
> 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")
> Signed-off-by: Nathan Lynch <nathan.lynch@amd.com>

Reviewed-by: Dave Jiang <dave.jiang@intel.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 bb146c5ac3e4ccd7bc0afbf3b28e5b3d659ad62f..51e1e357892a0325646f82d580b199321d59ced4 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: 6565439894570a07b00dba0b739729fe6b56fba4
> change-id: 20250312-dma_async_tx_desc-tx_submit-doc-58a4cfee2e8b
> 
> Best regards,