Fix the examples in the netmap compatibility sample application
docs which referred to the packet_reordering application.
Also fix some minor rst formatting issues.
Reported-by: Qian Xu
Signed-off-by: John McNamara
---
doc/guides/sample_app_ug/netmap_compatibility.rst | 91 ---
1 file changed, 46 insertions(+), 45 deletions(-)
diff --git a/doc/guides/sample_app_ug/netmap_compatibility.rst
b/doc/guides/sample_app_ug/netmap_compatibility.rst
index d86b3e3..41f0518 100644
--- a/doc/guides/sample_app_ug/netmap_compatibility.rst
+++ b/doc/guides/sample_app_ug/netmap_compatibility.rst
@@ -35,13 +35,13 @@ Netmap Compatibility Sample Application
Introduction
-The Netmap compatibility library provides a minimal set of APIs to give the
ability to programs written against the Netmap APIs
-to be run with minimal changes to their source code, using the DPDK to
perform the actual packet I/O.
+The Netmap compatibility library provides a minimal set of APIs to give
programs written against the Netmap APIs
+the ability to be run, with minimal changes to their source code, using the
DPDK to perform the actual packet I/O.
-Since Netmap applications use regular system calls, like open(), ioctl() and
-mmap() to communicate with the Netmap kernel module performing the packet I/O,
-the compat_netmap library provides a set of similar APIs to use in place of
those system calls,
-effectively turning a Netmap application into a DPDK one.
+Since Netmap applications use regular system calls, like ``open()``,
``ioctl()`` and
+``mmap()`` to communicate with the Netmap kernel module performing the packet
I/O,
+the ``compat_netmap`` library provides a set of similar APIs to use in place
of those system calls,
+effectively turning a Netmap application into a DPDK application.
The provided library is currently minimal and doesn't support all the features
that Netmap supports,
but is enough to run simple applications, such as the bridge example detailed
below.
@@ -52,15 +52,17 @@ Please refer to the Netmap distribution for details about
Netmap.
Available APIs
--
-The library provides the following drop-in replacements for system calls
usually used in Netmap applications:rte_netmap_close()
+The library provides the following drop-in replacements for system calls
usually used in Netmap applications:
-* rte_netmap_ioctl()
+* ``rte_netmap_close()``
-* rte_netmap_open()
+* ``rte_netmap_ioctl()``
-* rte_netmap_mmap()
+* ``rte_netmap_open()``
-* rte_netmap_poll()
+* ``rte_netmap_mmap()``
+
+* ``rte_netmap_poll()``
They use the same signature as their libc counterparts, and can be used as
drop-in replacements in most cases.
@@ -68,26 +70,25 @@ Caveats
---
Given the difference between the way Netmap and the DPDK approach packet I/O,
-there are caveats and limitations to be aware of when trying to use the
compat_netmap library, the most important of which are listed below.
-Additional caveats are presented in the
$RTE_SDK/examples/netmap_compat/README.md file.
-These can change as the library is updated:
+there are caveats and limitations to be aware of when trying to use the
``compat_netmap`` library, the most important of these are listed below.
+These may change as the library is updated:
-* Any system call that can potentially affect file descriptors cannot be
used with a descriptor returned by the rte_netmap_open() function.
+* Any system call that can potentially affect file descriptors cannot be
used with a descriptor returned by the ``rte_netmap_open()`` function.
Note that:
-* rte_netmap_mmap() merely returns the address of a DPDK memzone.
-The address, length, flags, offset, and so on arguments are therefore
ignored completely.
+* The ``rte_netmap_mmap()`` function merely returns the address of a DPDK
memzone.
+The address, length, flags, offset, and other arguments are ignored.
-* rte_netmap_poll() only supports infinite (negative) or zero time outs.
-It effectively turns calls to the poll() system call made in a Netmap
application into polling of the DPDK ports,
+* The ``rte_netmap_poll()`` function only supports infinite (negative) or
zero time outs.
+It effectively turns calls to the ``poll()`` system call made in a Netmap
application into polling of the DPDK ports,
changing the semantics of the usual POSIX defined poll.
-* Not all of Netmap's features are supported: "host rings",
+* Not all of Netmap's features are supported: host rings,
slot flags and so on are not supported or are simply not relevant in the
DPDK model.
-* The Netmap manual page states that "a device obtained through /dev/netmap
also supports the ioctl supported by network devices".
-It is not the case with this compatibility layer.
+* The Netmap manual page states that "*a device obtained through /dev/netmap
also supports the ioctl supported by network devices*".
+This is not the case with this com
