diff mbox

dmaengine: Update documentation for inline wrapper

Message ID 1408540725-20195-1-git-send-email-geert+renesas@glider.be (mailing list archive)
State Accepted
Headers show

Commit Message

Geert Uytterhoeven Aug. 20, 2014, 1:18 p.m. UTC 
Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
introduce inline wrappers") introduced some wrappers, but there is still
a reference to the old function.

Update the documentation to use the wrapper, and add a missing "()" to a
function name.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/dmaengine.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Vinod Koul Aug. 28, 2014, 7:08 a.m. UTC | #1 
On Wed, Aug 20, 2014 at 03:18:44PM +0200, Geert Uytterhoeven wrote:
> Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
> introduce inline wrappers") introduced some wrappers, but there is still
> a reference to the old function.
> 
> Update the documentation to use the wrapper, and add a missing "()" to a
> function name.
Thanks, applied, now
diff mbox

Patch

diff --git a/Documentation/dmaengine.txt b/Documentation/dmaengine.txt
index 573e28ce9751..11fb87ff6cd0 100644
--- a/Documentation/dmaengine.txt
+++ b/Documentation/dmaengine.txt
@@ -98,7 +98,7 @@  The slave DMA usage consists of following steps:
 		unsigned long flags);
 
    The peripheral driver is expected to have mapped the scatterlist for
-   the DMA operation prior to calling device_prep_slave_sg, and must
+   the DMA operation prior to calling dmaengine_prep_slave_sg(), and must
    keep the scatterlist mapped until the DMA operation has completed.
    The scatterlist must be mapped using the DMA struct device.
    If a mapping needs to be synchronized later, dma_sync_*_for_*() must be
@@ -195,5 +195,5 @@  Further APIs:
    Note:
 	Not all DMA engine drivers can return reliable information for
 	a running DMA channel.  It is recommended that DMA engine users
-	pause or stop (via dmaengine_terminate_all) the channel before
+	pause or stop (via dmaengine_terminate_all()) the channel before
 	using this API.