[dpdk-dev] [PATCH] doc: minor fixes in tap guide

[dpdk-dev] [PATCH] doc: minor fixes in tap guide

[Andrzej Ostruszka]

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
 
 Ensure packets from a given MAC address are received on a queue 2::
-- 
2.17.1

Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: minor fixes in tap guide

[Ferruh Yigit]

On 11/21/2019 1:27 PM, Andrzej Ostruszka 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

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/master, thanks.

Re: [dpdk-dev] [PATCH] doc: minor fixes in tap guide

[Stephen Hemminger]

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

Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: minor fixes in tap guide

[Ferruh Yigit]

On 11/21/2019 4:59 PM, Stephen Hemminger wrote:
> On Thu, 21 Nov 2019 14:27:01 +0100
> Alejandra 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....
> 

Good to know, thanks.

Alejandra, if you are OK I can update the IP address in the next-net?

Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: minor fixes in tap guide

[Ferruh Yigit]

On 11/22/2019 9:19 AM, Ferruh Yigit wrote:
> On 11/21/2019 4:59 PM, Stephen Hemminger wrote:
>> On Thu, 21 Nov 2019 14:27:01 +0100
>> Alejandra 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....
>>
> 
> Good to know, thanks.
> 
> Alejandra, if you are OK I can update the IP address in the next-net?
> 

updated to 192.0.2.1