[3/3] doc: update the doc for virtio-user
diff mbox series

Message ID 20180921125244.27861-4-tiwei.bie@intel.com
State Accepted, archived
Delegated to: Maxime Coquelin
Headers show
Series
  • Some fixes and doc updates for virtio-user
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Tiwei Bie Sept. 21, 2018, 12:52 p.m. UTC
Update the doc for virtio-user to use the latest testpmd
parameters and commands.

Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
---
 doc/guides/contributing/documentation.rst     |  4 ++--
 .../howto/virtio_user_as_exceptional_path.rst | 23 +++++++++++--------
 .../virtio_user_for_container_networking.rst  |  2 +-
 3 files changed, 16 insertions(+), 13 deletions(-)

Comments

Maxime Coquelin Sept. 27, 2018, 11:53 a.m. UTC | #1
On 09/21/2018 02:52 PM, Tiwei Bie wrote:
> Update the doc for virtio-user to use the latest testpmd
> parameters and commands.
> 
> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
> ---
>   doc/guides/contributing/documentation.rst     |  4 ++--
>   .../howto/virtio_user_as_exceptional_path.rst | 23 +++++++++++--------
>   .../virtio_user_for_container_networking.rst  |  2 +-
>   3 files changed, 16 insertions(+), 13 deletions(-)
> 


Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks!
Maxime

Patch
diff mbox series

diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 6a075553d..097575ad7 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -297,8 +297,8 @@  Line Length
 
      testpmd -l 2-3 -n 4 \
              --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \
-             -- -i --txqflags=0x0 --enable-hw-vlan --enable-lro \
-             --enable-rx-cksum --txq=2 --rxq=2 --rxd=1024  --txd=1024
+             -- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \
+             --txd=1024 --rxd=1024
 
 
 Whitespace
diff --git a/doc/guides/howto/virtio_user_as_exceptional_path.rst b/doc/guides/howto/virtio_user_as_exceptional_path.rst
index 6a13c761e..4910c12df 100644
--- a/doc/guides/howto/virtio_user_as_exceptional_path.rst
+++ b/doc/guides/howto/virtio_user_as_exceptional_path.rst
@@ -57,8 +57,8 @@  compiling the kernel and those kernel modules should be inserted.
 
         $(testpmd) -l 2-3 -n 4 \
 		--vdev=virtio_user0,path=/dev/vhost-net,queue_size=1024 \
-		-- -i --txqflags=0x0 --enable-lro \
-		--enable-rx-cksum --rxd=1024 --txd=1024
+		-- -i --tx-offloads=0x0000002c --enable-lro \
+		--txd=1024 --rxd=1024
 
     This command runs testpmd with two ports, one physical NIC to communicate
     with outside, and one virtio-user to communicate with kernel.
@@ -69,11 +69,6 @@  compiling the kernel and those kernel modules should be inserted.
     VIRTIO_NET_F_GUEST_TSO6 feature so that large packets from kernel can be
     transmitted to DPDK application and further TSOed by physical NIC.
 
-* ``--enable-rx-cksum``
-
-    This is used to negotiate VIRTIO_NET_F_GUEST_CSUM so that packets from
-    kernel can be deemed as valid Rx checksumed.
-
 * ``queue_size``
 
     256 by default. To avoid shortage of descriptors, we can increase it to 1024.
@@ -86,9 +81,17 @@  compiling the kernel and those kernel modules should be inserted.
 
         $(testpmd) -l 2-3 -n 4 \
 		--vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \
-		-- -i --txqflags=0x0 --enable-lro \
-		--enable-rx-cksum --txq=2 --rxq=2 --rxd=1024 \
-		--txd=1024
+		-- -i --tx-offloads=0x0000002c --enable-lro \
+		--txq=2 --rxq=2 --txd=1024 --rxd=1024
+
+#. Enable Rx checksum offloads in testpmd:
+
+    .. code-block:: console
+
+        (testpmd) port stop 0
+        (testpmd) port config 0 rx_offload tcp_cksum on
+        (testpmd) port config 0 rx_offload udp_cksum on
+        (testpmd) port start 0
 
 #. Start testpmd:
 
diff --git a/doc/guides/howto/virtio_user_for_container_networking.rst b/doc/guides/howto/virtio_user_for_container_networking.rst
index 476ce3a63..2313dc794 100644
--- a/doc/guides/howto/virtio_user_for_container_networking.rst
+++ b/doc/guides/howto/virtio_user_for_container_networking.rst
@@ -96,7 +96,7 @@  some minor changes.
             dpdk-app-testpmd testpmd -l 6-7 -n 4 -m 1024 --no-pci \
             --vdev=virtio_user0,path=/var/run/usvhost \
             --file-prefix=container \
-            -- -i --txqflags=0xf00 --disable-hw-vlan
+            -- -i
 
 Note: If we run all above setup on the host, it's a shm-based IPC.