doc: fix address type description for IOAT rawdev

Message ID 20191018000147.193134-1-xiao.w.wang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series doc: fix address type description for IOAT rawdev |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK

Commit Message

Xiao Wang Oct. 18, 2019, 12:01 a.m. UTC
  Align the description to what the code snippet shows.

Fixes: 0a92e63fc4cd ("raw/ioat: add local API to perform copies")

Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
---
 doc/guides/rawdevs/ioat.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Bruce Richardson Oct. 17, 2019, 1:48 p.m. UTC | #1
On Thu, Oct 17, 2019 at 08:01:47PM -0400, Xiao Wang wrote:
> Align the description to what the code snippet shows.
> 
> Fixes: 0a92e63fc4cd ("raw/ioat: add local API to perform copies")
> 
> Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
> ---
>  doc/guides/rawdevs/ioat.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/guides/rawdevs/ioat.rst b/doc/guides/rawdevs/ioat.rst
> index 607cb5a86..d0eee5e23 100644
> --- a/doc/guides/rawdevs/ioat.rst
> +++ b/doc/guides/rawdevs/ioat.rst
> @@ -160,7 +160,7 @@ the application calls ``rte_ioat_completed_copies()``.
>  
>  The ``rte_ioat_enqueue_copy()`` function enqueues a single copy to the
>  device ring for copying at a later point. The parameters to that function
> -include the physical addresses of both the source and destination buffers,
> +include the IOVA addresses of both the source and destination buffers,
>  as well as two "handles" to be returned to the user when the copy is
>  completed. These handles can be arbitrary values, but two are provided so
>  that the library can track handles for both source and destination on
> -- 

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  
David Marchand Nov. 15, 2019, 9:03 a.m. UTC | #2
On Thu, Oct 17, 2019 at 3:48 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
> On Thu, Oct 17, 2019 at 08:01:47PM -0400, Xiao Wang wrote:
> > Align the description to what the code snippet shows.
> >
> > Fixes: 0a92e63fc4cd ("raw/ioat: add local API to perform copies")
Cc: stable@dpdk.org

> >
> > Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rawdevs/ioat.rst b/doc/guides/rawdevs/ioat.rst
index 607cb5a86..d0eee5e23 100644
--- a/doc/guides/rawdevs/ioat.rst
+++ b/doc/guides/rawdevs/ioat.rst
@@ -160,7 +160,7 @@  the application calls ``rte_ioat_completed_copies()``.
 
 The ``rte_ioat_enqueue_copy()`` function enqueues a single copy to the
 device ring for copying at a later point. The parameters to that function
-include the physical addresses of both the source and destination buffers,
+include the IOVA addresses of both the source and destination buffers,
 as well as two "handles" to be returned to the user when the copy is
 completed. These handles can be arbitrary values, but two are provided so
 that the library can track handles for both source and destination on