DPDK patches and discussions
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: Andrzej Ostruszka <aostruszka@marvell.com>
Cc: <dev@dpdk.org>, Keith Wiles <keith.wiles@intel.com>,
	John McNamara <john.mcnamara@intel.com>,
	Marko Kovacevic <marko.kovacevic@intel.com>, <stable@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: minor fixes in tap guide
Date: Thu, 21 Nov 2019 08:59:13 -0800	[thread overview]
Message-ID: <20191121085913.6d7ecc2f@hermes.lan> (raw)
In-Reply-To: <20191121132701.31856-1-aostruszka@marvell.com>

On Thu, 21 Nov 2019 14:27:01 +0100
Andrzej Ostruszka <aostruszka@marvell.com> wrote:

> Corrected one typo and ip address.
> 
> Signed-off-by: Andrzej Ostruszka <aostruszka@marvell.com>
> 
> Fixes: de96fe68ae95 ("net/tap: add basic flow API patterns and actions")
> Cc: stable@dpdk.org
> ---
>  doc/guides/nics/tap.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst
> index 4b6d77d37..b6a626a40 100644
> --- a/doc/guides/nics/tap.rst
> +++ b/doc/guides/nics/tap.rst
> @@ -76,7 +76,7 @@ Please change the IP addresses as you see fit.
>  
>  If routing is enabled on the host you can also communicate with the DPDK App
>  over the internet via a standard socket layer application as long as you
> -account for the protocol handing in the application.
> +account for the protocol handling in the application.
>  
>  If you have a Network Stack in your DPDK application or something like it you
>  can utilize that stack to handle the network protocols. Plus you would be able
> @@ -134,7 +134,7 @@ Examples of testpmd flow rules
>  
>  Drop packets for destination IP 192.168.0.1::
>  
> -   testpmd> flow create 0 priority 1 ingress pattern eth / ipv4 dst is 1.1.1.1 \  
> +   testpmd> flow create 0 priority 1 ingress pattern eth / ipv4 dst is 192.168.0.1 \
>              / end actions drop / end

There is a standard RFC for what address to use in documentation.

RFC5735
   192.0.2.0/24 - This block is assigned as "TEST-NET-1" for use in
   documentation and example code.  It is often used in conjunction with
   domain names example.com or example.net in vendor and protocol
   documentation.  As described in [RFC5737], addresses within this
   block do not legitimately appear on the public Internet and can be
   used without any coordination with IANA or an Internet registry.  See
   [RFC1166].


This is done so that users don't blindly cut/paste from documentation....

  parent reply	other threads:[~2019-11-21 16:59 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-21 13:27 Andrzej Ostruszka
2019-11-21 16:32 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
2019-11-21 16:59 ` Stephen Hemminger [this message]
2019-11-22  9:19   ` Ferruh Yigit
2019-11-22 12:25     ` 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=20191121085913.6d7ecc2f@hermes.lan \
    --to=stephen@networkplumber.org \
    --cc=aostruszka@marvell.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=keith.wiles@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).