docs: dma-api: Fix description of the sync_sg API
authorBrian Johannesmeyer <bjohannesmeyer@gmail.com>
Fri, 3 Nov 2023 16:21:20 +0000 (17:21 +0100)
committerJonathan Corbet <corbet@lwn.net>
Fri, 17 Nov 2023 15:52:13 +0000 (08:52 -0700)
Fix the description of the parameters to dma_sync_sg*. They should be the
same as the parameters to dma_map_sg(), not dma_map_single().

Signed-off-by: Brian Johannesmeyer <bjohannesmeyer@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20231103162120.3474026-1-bjohannesmeyer@gmail.com>

Documentation/core-api/dma-api.rst

index 829f20a193cabbe78ca32ba0b1dc1939feccecb8..8e3cce3d0a230b9b107400d53875d6de06827e43 100644 (file)
@@ -448,7 +448,7 @@ DMA address entries returned.
 
 Synchronise a single contiguous or scatter/gather mapping for the CPU
 and device. With the sync_sg API, all the parameters must be the same
-as those passed into the single mapping API. With the sync_single API,
+as those passed into the sg mapping API. With the sync_single API,
 you can use dma_handle and size parameters that aren't identical to
 those passed into the single mapping API to do a partial sync.