[dpdk-dev] [PATCH] doc: fixed verbatim sections in vmxnet3 docs

[dpdk-dev] [PATCH] doc: fixed verbatim sections in vmxnet3 docs

[John McNamara]

Fixed two verbatim text sections in vmxnet3 docs.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/nics/vmxnet3.rst | 27 ++++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)

diff --git a/doc/guides/nics/vmxnet3.rst b/doc/guides/nics/vmxnet3.rst
index 3aa5b40..830530d 100644
--- a/doc/guides/nics/vmxnet3.rst
+++ b/doc/guides/nics/vmxnet3.rst
@@ -149,10 +149,15 @@ This section describes an example setup for Phy-vSwitch-VM-Phy communication.
     Other instructions on preparing to use DPDK such as, hugepage enabling, uio port binding are not listed here.
     Please refer to *DPDK Getting Started Guide and DPDK Sample Application's User Guide* for detailed instructions.
 
-The packet reception and transmission flow path is:
+The packet reception and transmission flow path is::
 
-    Packet generator -> 82576 -> VMware ESXi vSwitch -> VMXNET3 device -> Guest VM VMXNET3 port 0 rx burst -> Guest
-    VM 82599 VF port 0 tx burst -> 82599 VF -> Packet generator
+    Packet generator -> 82576
+                     -> VMware ESXi vSwitch
+                     -> VMXNET3 device
+                     -> Guest VM VMXNET3 port 0 rx burst
+                     -> Guest VM 82599 VF port 0 tx burst
+                     -> 82599 VF
+                     -> Packet generator
 
 VMXNET3 Chaining VMs Connected to a vSwitch
 -------------------------------------------
@@ -166,7 +171,15 @@ The following figure shows an example VM-to-VM communication over a Phy-VM-vSwit
     When using the L2 Forwarding or L3 Forwarding applications,
     a destination MAC address needs to be written in packets to hit the other VM's VMXNET3 interface.
 
-In this example, the packet flow path is:
-
-    Packet generator -> 82599 VF -> Guest VM 82599 port 0 rx burst -> Guest VM VMXNET3 port 1 tx burst -> VMXNET3
-    device -> VMware ESXi vSwitch -> VMXNET3 device -> Guest VM VMXNET3 port 0 rx burst -> Guest VM 82599 VF port 1 tx burst -> 82599 VF -> Packet generator
+In this example, the packet flow path is::
+
+    Packet generator -> 82599 VF
+                     -> Guest VM 82599 port 0 rx burst
+                     -> Guest VM VMXNET3 port 1 tx burst
+                     -> VMXNET3 device
+                     -> VMware ESXi vSwitch
+                     -> VMXNET3 device
+                     -> Guest VM VMXNET3 port 0 rx burst
+                     -> Guest VM 82599 VF port 1 tx burst
+                     -> 82599 VF
+                     -> Packet generator
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH] doc: fixed verbatim sections in vmxnet3 docs

[Yong Wang]

On 4/10/15, 7:45 AM, "John McNamara" <john.mcnamara@intel.com> wrote:

>Fixed two verbatim text sections in vmxnet3 docs.
>
>Signed-off-by: John McNamara <john.mcnamara@intel.com>

This patch looks good.

Just want to point out that there are some places in the same doc that
needs fixing.  For example, in the various diagrams, specific versions of
DPDK and ESXi are used.  I understand that vmxnet3 pmd was introduced in
1.6 but I prefer them to be version-agonostic since the same diagram works
for 1.7, 1.8, etc and I don’t see much benefits in spelling out 1.6 in
this case.  Same arguments to the ESXi version.

Acked-by: Yong Wang <yongwang@vmware.com>


>---
> doc/guides/nics/vmxnet3.rst | 27 ++++++++++++++++++++-------
> 1 file changed, 20 insertions(+), 7 deletions(-)
>
>diff --git a/doc/guides/nics/vmxnet3.rst b/doc/guides/nics/vmxnet3.rst
>index 3aa5b40..830530d 100644
>--- a/doc/guides/nics/vmxnet3.rst
>+++ b/doc/guides/nics/vmxnet3.rst
>@@ -149,10 +149,15 @@ This section describes an example setup for
>Phy-vSwitch-VM-Phy communication.
>     Other instructions on preparing to use DPDK such as, hugepage
>enabling, uio port binding are not listed here.
>     Please refer to *DPDK Getting Started Guide and DPDK Sample
>Application's User Guide* for detailed instructions.
> 
>-The packet reception and transmission flow path is:
>+The packet reception and transmission flow path is::
> 
>-    Packet generator -> 82576 -> VMware ESXi vSwitch -> VMXNET3 device
>-> Guest VM VMXNET3 port 0 rx burst -> Guest
>-    VM 82599 VF port 0 tx burst -> 82599 VF -> Packet generator
>+    Packet generator -> 82576
>+                     -> VMware ESXi vSwitch
>+                     -> VMXNET3 device
>+                     -> Guest VM VMXNET3 port 0 rx burst
>+                     -> Guest VM 82599 VF port 0 tx burst
>+                     -> 82599 VF
>+                     -> Packet generator
> 
> VMXNET3 Chaining VMs Connected to a vSwitch
> -------------------------------------------
>@@ -166,7 +171,15 @@ The following figure shows an example VM-to-VM
>communication over a Phy-VM-vSwit
>     When using the L2 Forwarding or L3 Forwarding applications,
>     a destination MAC address needs to be written in packets to hit the
>other VM's VMXNET3 interface.
> 
>-In this example, the packet flow path is:
>-
>-    Packet generator -> 82599 VF -> Guest VM 82599 port 0 rx burst ->
>Guest VM VMXNET3 port 1 tx burst -> VMXNET3
>-    device -> VMware ESXi vSwitch -> VMXNET3 device -> Guest VM VMXNET3
>port 0 rx burst -> Guest VM 82599 VF port 1 tx burst -> 82599 VF ->
>Packet generator
>+In this example, the packet flow path is::
>+
>+    Packet generator -> 82599 VF
>+                     -> Guest VM 82599 port 0 rx burst
>+                     -> Guest VM VMXNET3 port 1 tx burst
>+                     -> VMXNET3 device
>+                     -> VMware ESXi vSwitch
>+                     -> VMXNET3 device
>+                     -> Guest VM VMXNET3 port 0 rx burst
>+                     -> Guest VM 82599 VF port 1 tx burst
>+                     -> 82599 VF
>+                     -> Packet generator
>-- 
>1.8.1.4
>

Re: [dpdk-dev] [PATCH] doc: fixed verbatim sections in vmxnet3 docs

[Thomas Monjalon]

> >Fixed two verbatim text sections in vmxnet3 docs.
> >
> >Signed-off-by: John McNamara <john.mcnamara@intel.com>
> 
> This patch looks good.
[...]
> Acked-by: Yong Wang <yongwang@vmware.com>

Applied, thanks