DPDK patches and discussions
 help / color / mirror / Atom feed

From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Ori Kam <orika@mellanox.com>,
	"adrien.mazarguil@6wind.com" <adrien.mazarguil@6wind.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: add basic howto for flow API
Date: Thu, 19 Oct 2017 10:05:53 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EDDC589@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1508396139-27687-1-git-send-email-orika@mellanox.com>



> -----Original Message-----
> From: Ori Kam [mailto:orika@mellanox.com]
> Sent: Thursday, October 19, 2017 7:56 AM
> To: adrien.mazarguil@6wind.com; Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; orika@mellanox.com
> Subject: [PATCH] doc: add basic howto for flow API
> 
> As the rte flow is a new complex module in the DPDK.
> In order to ease developers in to using this feature it was suggested to
> supply a simple howto doc.
> 
> Signed-off-by: Ori Kam <orika@mellanox.com>

Hi Ori,

Thanks for useful and very doc. It is good to see additions to the How-to guides.
We should have more of those.

Some minor comments below.


>
> +  tpmd> flow create 0 ingress pattern eth / vlan / ipv4 dst is
> + 192.168.3.2 / end actions drop / end


The testpmd commands are very long and run off the page in the 
PDF and Html docs.

Something like the following would be better and just as clear:


In this example we will create a simple rule that drops packets whose IPv4
destination equals 192.168.3.2. This code is equivalent to the following
testpmd command (wrapped for clarity)::

  tpmd> flow create 0 ingress pattern eth / vlan /
                    ipv4 dst is 192.168.3.2 / end actions drop / end



> +  $scapy
> +  welcome to Scapy
> +  >> sendp(Ether()/Dot1Q()/IP(src='176.80.50.4', dst='192.168.3.1'),
> + iface = <some interface>, count 1)  >>
> + sendp(Ether()/Dot1Q()/IP(src='176.80.50.5', dst='192.168.3.2'), iface
> + = <some interface>, count 1)
> +
> +terminal 1: output log::
> +
> +  received packet with src ip = 176.80.50.4  received packet with src
> + ip = 176.80.50.5
> +
> +terminal 1: running sample app flow rule enabled::
> +
> +  ./filter-program enabled
> +  [waiting for packets]
> +
> +terminal 2: running  scapy::
> +
> +  $scapy
> +  welcome to Scapy
> +  >> sendp(Ether()/Dot1Q()/IP(src='176.80.50.4', dst='192.168.3.1'),
> + iface = <some interface>, count 1)  >>

There is a typo here and in the other scapy commands. It should be:

    count=1

Also <some interface> would be better as a string. And the line is also long
so something like this would be better:

Terminal 2: running  scapy::

  $scapy
  welcome to Scapy
  >> sendp(Ether()/Dot1Q()/IP(src='176.80.50.4', dst='192.168.3.1'), \
           iface='some interface', count=1)
  >> sendp(Ether()/Dot1Q()/IP(src='176.80.50.5', dst='192.168.3.2'), \
           iface='some interface', count=1)

I have some other small comments/suggestions that I will send to you offline.

Thanks,

John

next prev parent reply	other threads:[~2017-10-19 10:05 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-19  6:55 Ori Kam
2017-10-19 10:05 ` Mcnamara, John [this message]
2017-10-21  7:29   ` Ori Kam
2017-10-25 14:51 ` [dpdk-dev] [PATCH v2] " Ori Kam
2017-10-25 15:27   ` Mcnamara, John
2017-10-26 23:18     ` Thomas Monjalon
2017-11-02 17:06       ` Mcnamara, John
2017-11-07 21:54     ` 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=B27915DBBA3421428155699D51E4CFE23EDDC589@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=adrien.mazarguil@6wind.com \
    --cc=dev@dpdk.org \
    --cc=orika@mellanox.com \
    /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

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).