DPDK patches and discussions
 help / color / mirror / Atom feed
From: Kevin Traynor <ktraynor@redhat.com>
To: john.mcnamara@intel.com, marko.kovacevic@intel.com, dev@dpdk.org
Cc: Kevin Traynor <ktraynor@redhat.com>, stable@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: fix some formatting errors in testpmd guide
Date: Thu,  2 May 2019 19:43:42 +0100	[thread overview]
Message-ID: <20190502184342.28988-1-ktraynor@redhat.com> (raw)
Message-ID: <20190502184342._5P-dkkcG0P4gNPm9GqIyh0QlCM2BjaBaoY3GQS_sBM@z> (raw)

Minor formatting error related to code block noticed when reading the doc.
Fix it and some other errors.

Fixes: c7217b9dd8ef ("app/testpmd: change log level at run time")
Fixes: 3c272b280a50 ("app/testpmd: add commands for RSS queue region")
Fixes: e38ea44f1714 ("app/testpmd: add configuration for input set")
Fixes: 08e0b3440baf ("app/testpmd: add option to configure UDP tunnel port")
Fixes: e977e4199a8d ("app/testpmd: add commands to load/unload BPF filters")
Cc: stable@dpdk.org

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 5d4dc6f0c..a8c44d376 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -514,7 +514,9 @@ Where:
 
 For example, to change the global log level::
+
 	testpmd> set log global (level)
 
 Regexes can also be used for type. To change log level of user1, user2 and user3::
+
 	testpmd> set log user[1-3] (level)
 
@@ -970,9 +972,10 @@ Flush all queue region related configuration on a port::
 where:
 
-* "on"is just an enable function which server for other configuration,
+* ``on``: is just an enable function which server for other configuration,
   it is for all configuration about queue region from up layer,
   at first will only keep in DPDK software stored in driver,
   only after "flush on", it commit all configuration to HW.
-  "off" is just clean all configuration about queue region just now,
+
+* ``"off``: is just clean all configuration about queue region just now,
   and restore all to DPDK i40e driver default config when start up.
 
@@ -2157,4 +2160,5 @@ port config input set
 
 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
+
    testpmd> port config (port_id) pctype (pctype_id) \
             (hash_inset|fdir_inset|fdir_flx_inset) \
@@ -2162,4 +2166,5 @@ Config RSS/FDIR/FDIR flexible payload input set for some pctype::
 
 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
+
    testpmd> port config (port_id) pctype (pctype_id) \
             (hash_inset|fdir_inset|fdir_flx_inset) clear all
@@ -2174,4 +2179,5 @@ port config udp_tunnel_port
 
 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
+
     testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
 
@@ -4546,5 +4552,5 @@ For example:
    clang -O2 -target bpf -c t1.c
 
-Then to load (and JIT compile) t1.o at RX queue 0, port 1::
+Then to load (and JIT compile) t1.o at RX queue 0, port 1:
 
 .. code-block:: console
@@ -4552,5 +4558,5 @@ Then to load (and JIT compile) t1.o at RX queue 0, port 1::
    testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
 
-To load (not JITed) t1.o at TX queue 0, port 0::
+To load (not JITed) t1.o at TX queue 0, port 0:
 
 .. code-block:: console
-- 
2.20.1


             reply	other threads:[~2019-05-02 18:43 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-02 18:43 Kevin Traynor [this message]
2019-05-02 18:43 ` Kevin Traynor
2019-05-07 15:37 ` Iremonger, Bernard
2019-05-07 15:37   ` Iremonger, Bernard
2019-05-09 22:09   ` [dpdk-dev] [dpdk-stable] " Thomas Monjalon
2019-05-09 22:09     ` Thomas Monjalon

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=20190502184342.28988-1-ktraynor@redhat.com \
    --to=ktraynor@redhat.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --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).