DPDK patches and discussions
 help / color / mirror / Atom feed
From: Wenzhuo Lu <wenzhuo.lu@intel.com>
To: dev@dpdk.org
Cc: Wenzhuo Lu <wenzhuo.lu@intel.com>, stable@dpdk.org
Subject: [dpdk-dev] [PATCH v2 1/2] doc: fix framework of ixgbe doc
Date: Thu,  9 Feb 2017 09:27:59 +0800	[thread overview]
Message-ID: <1486603680-62864-2-git-send-email-wenzhuo.lu@intel.com> (raw)
In-Reply-To: <1486603680-62864-1-git-send-email-wenzhuo.lu@intel.com>

The framework of the ixgbe doc is not appropriate,
adjust it.

Fixes: 972e365bfe7a ("doc: nics guide")
CC: stable@dpdk.org

Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
---
 doc/guides/nics/ixgbe.rst | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst
index 3b6851b..05ecc2a 100644
--- a/doc/guides/nics/ixgbe.rst
+++ b/doc/guides/nics/ixgbe.rst
@@ -129,7 +129,7 @@ The tx_rs_thresh value must be greater than or equal to RTE_PMD_IXGBE_TX_MAX_BUR
 but less or equal to RTE_IXGBE_TX_MAX_FREE_BUF_SZ.
 Consequently, by default the tx_rs_thresh value is in the range 32 to 64.
 
-Feature not Supported by RX Vector PMD
+Feature not Supported by TX Vector PMD
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 TX vPMD only works when txq_flags is set to IXGBE_SIMPLE_FLAGS.
@@ -148,16 +148,16 @@ The following MACROs are used for these three features:
 *   ETH_TXQ_FLAGS_NOXSUMTCP
 
 Application Programming Interface
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------
 
 In DPDK release v16.11 an API for ixgbe specific functions has been added to the ixgbe PMD.
 The declarations for the API functions are in the header ``rte_pmd_ixgbe.h``.
 
 Sample Application Notes
-~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------
 
 testpmd
-^^^^^^^
+~~~~~~~
 
 By default, using CONFIG_RTE_IXGBE_RX_OLFLAGS_ENABLE=y:
 
@@ -172,21 +172,24 @@ When CONFIG_RTE_IXGBE_RX_OLFLAGS_ENABLE=n, better performance can be achieved:
     ./x86_64-native-linuxapp-gcc/app/testpmd -c 300 -n 4 -- -i --burst=32 --rxfreet=32 --mbcache=250 --txpt=32 --rxht=8 --rxwt=0 --txfreet=32 --txrst=32 --txqflags=0xf01 --disable-hw-vlan
 
 l3fwd
-^^^^^
+~~~~~
 
 When running l3fwd with vPMD, there is one thing to note.
 In the configuration, ensure that port_conf.rxmode.hw_ip_checksum=0.
 Otherwise, by default, RX vPMD is disabled.
 
 load_balancer
-^^^^^^^^^^^^^
+~~~~~~~~~~~~~
 
 As in the case of l3fwd, set configure port_conf.rxmode.hw_ip_checksum=0 to enable vPMD.
 In addition, for improved performance, use -bsz "(32,32),(64,64),(32,32)" in load_balancer to avoid using the default burst size of 144.
 
 
+Limitations or Known issues
+---------------------------
+
 Malicious Driver Detection not Supported
-----------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The Intel x550 series NICs support a feature called MDD (Malicious
 Driver Detection) which checks the behavior of the VF driver.
@@ -207,7 +210,7 @@ it by default.)
 
 
 Statistics
-----------
+~~~~~~~~~~
 
 The statistics of ixgbe hardware must be polled regularly in order for it to
 remain consistent. Running a DPDK application without polling the statistics will
-- 
1.9.3

  reply	other threads:[~2017-02-09  1:27 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-02-07  6:22 [dpdk-dev] [PATCH] doc: announce ixgbe MTU setting limitation Wenzhuo Lu
2017-02-08 16:12 ` Ferruh Yigit
2017-02-09  0:40   ` Lu, Wenzhuo
2017-02-08 17:10 ` Mcnamara, John
2017-02-09  0:42   ` Lu, Wenzhuo
2017-02-09  1:27 ` [dpdk-dev] [PATCH v2 0/2] update ixgbe doc Wenzhuo Lu
2017-02-09  1:27   ` Wenzhuo Lu [this message]
2017-02-09 15:05     ` [dpdk-dev] [dpdk-stable] [PATCH v2 1/2] doc: fix framework of " Mcnamara, John
2017-02-09  1:28   ` [dpdk-dev] [PATCH v2 2/2] doc: announce ixgbe MTU setting limitation Wenzhuo Lu
2017-02-09 15:05     ` Mcnamara, John
2017-02-09 15:28   ` [dpdk-dev] [PATCH v2 0/2] update ixgbe doc Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1486603680-62864-2-git-send-email-wenzhuo.lu@intel.com \
    --to=wenzhuo.lu@intel.com \
    --cc=dev@dpdk.org \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).