diff mbox series

[ovs-dev] meta-flow: fix a typo in "MPLS Bottom of Stack Field" paragraph

Message ID b704e023cff2d626e1fc63266a61809c6627dd62.1596731630.git.tredaelli@redhat.com
State Accepted
Delegated to: Ilya Maximets
Headers show
Series [ovs-dev] meta-flow: fix a typo in "MPLS Bottom of Stack Field" paragraph | expand

Commit Message

Timothy Redaelli Aug. 6, 2020, 4:33 p.m. UTC
In the ovs-fields.7 manual page, the "MPLS Bottom of Stack Field" paragraph
says:
 * When mpls_bos is 1, there is another MPLS label following this one,
   so the Ethertype passed to pop_mpls should be an MPLS Ethertype. [...]

 * When mpls_bos is 0, this MPLS label is the last one, so the Ethertype
   passed to pop_mpls should be a non-MPLS Ethertype such as IPv4. [...]

The values 0 and 1 have been swapped: when BOS is 1,
then no more label stack entries follows.

Fixes: 96fee5e0a2a0 ("ovs-fields: New manpage to document Open vSwitch and OpenFlow fields.")
Cc: blp@ovn.org
Reported-at: https://bugzilla.redhat.com/1842032
Reported-by: Guillaume Nault <gnault@redhat.com>
Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
---
 lib/meta-flow.xml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Gregory Rose Aug. 6, 2020, 7:32 p.m. UTC | #1
On 8/6/2020 9:33 AM, Timothy Redaelli wrote:
> In the ovs-fields.7 manual page, the "MPLS Bottom of Stack Field" paragraph
> says:
>   * When mpls_bos is 1, there is another MPLS label following this one,
>     so the Ethertype passed to pop_mpls should be an MPLS Ethertype. [...]
> 
>   * When mpls_bos is 0, this MPLS label is the last one, so the Ethertype
>     passed to pop_mpls should be a non-MPLS Ethertype such as IPv4. [...]
> 
> The values 0 and 1 have been swapped: when BOS is 1,
> then no more label stack entries follows.
> 
> Fixes: 96fee5e0a2a0 ("ovs-fields: New manpage to document Open vSwitch and OpenFlow fields.")
> Cc: blp@ovn.org
> Reported-at: https://bugzilla.redhat.com/1842032
> Reported-by: Guillaume Nault <gnault@redhat.com>
> Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>

Thanks for fixing the documentation.

Acked-by: Greg Rose <gvrose8192@gmail.com>

> ---
>   lib/meta-flow.xml | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/lib/meta-flow.xml b/lib/meta-flow.xml
> index 154675874..e72ba52ec 100644
> --- a/lib/meta-flow.xml
> +++ b/lib/meta-flow.xml
> @@ -3920,18 +3920,18 @@ r r c c c.
>   
>         <ul>
>           <li>
> -          When <ref field="mpls_bos"/> is 1, there is another MPLS label
> +          When <ref field="mpls_bos"/> is 0, there is another MPLS label
>             following this one, so the Ethertype passed to <code>pop_mpls</code>
>             should be an MPLS Ethertype.  For example: <code>table=0,
> -          dl_type=0x8847, mpls_bos=1, actions=pop_mpls:0x8847,
> +          dl_type=0x8847, mpls_bos=0, actions=pop_mpls:0x8847,
>             goto_table:1</code>
>           </li>
>   
>           <li>
> -          When <ref field="mpls_bos"/> is 0, this MPLS label is the last one,
> +          When <ref field="mpls_bos"/> is 1, this MPLS label is the last one,
>             so the Ethertype passed to <code>pop_mpls</code> should be a non-MPLS
>             Ethertype such as IPv4.  For example: <code>table=1, dl_type=0x8847,
> -          mpls_bos=0, actions=pop_mpls:0x0800, goto_table:2</code>
> +          mpls_bos=1, actions=pop_mpls:0x0800, goto_table:2</code>
>           </li>
>         </ul>
>       </field>
>
Ilya Maximets Aug. 26, 2020, 8:05 p.m. UTC | #2
On 8/6/20 9:32 PM, Gregory Rose wrote:
> 
> 
> On 8/6/2020 9:33 AM, Timothy Redaelli wrote:
>> In the ovs-fields.7 manual page, the "MPLS Bottom of Stack Field" paragraph
>> says:
>>   * When mpls_bos is 1, there is another MPLS label following this one,
>>     so the Ethertype passed to pop_mpls should be an MPLS Ethertype. [...]
>>
>>   * When mpls_bos is 0, this MPLS label is the last one, so the Ethertype
>>     passed to pop_mpls should be a non-MPLS Ethertype such as IPv4. [...]
>>
>> The values 0 and 1 have been swapped: when BOS is 1,
>> then no more label stack entries follows.
>>
>> Fixes: 96fee5e0a2a0 ("ovs-fields: New manpage to document Open vSwitch and OpenFlow fields.")
>> Cc: blp@ovn.org
>> Reported-at: https://bugzilla.redhat.com/1842032
>> Reported-by: Guillaume Nault <gnault@redhat.com>
>> Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
> 
> Thanks for fixing the documentation.
> 
> Acked-by: Greg Rose <gvrose8192@gmail.com>

Thanks!

Applied to master and backported down to 2.10.

Best regards, Ilya Maximets.
diff mbox series

Patch

diff --git a/lib/meta-flow.xml b/lib/meta-flow.xml
index 154675874..e72ba52ec 100644
--- a/lib/meta-flow.xml
+++ b/lib/meta-flow.xml
@@ -3920,18 +3920,18 @@  r r c c c.
 
       <ul>
         <li>
-          When <ref field="mpls_bos"/> is 1, there is another MPLS label
+          When <ref field="mpls_bos"/> is 0, there is another MPLS label
           following this one, so the Ethertype passed to <code>pop_mpls</code>
           should be an MPLS Ethertype.  For example: <code>table=0,
-          dl_type=0x8847, mpls_bos=1, actions=pop_mpls:0x8847,
+          dl_type=0x8847, mpls_bos=0, actions=pop_mpls:0x8847,
           goto_table:1</code>
         </li>
 
         <li>
-          When <ref field="mpls_bos"/> is 0, this MPLS label is the last one,
+          When <ref field="mpls_bos"/> is 1, this MPLS label is the last one,
           so the Ethertype passed to <code>pop_mpls</code> should be a non-MPLS
           Ethertype such as IPv4.  For example: <code>table=1, dl_type=0x8847,
-          mpls_bos=0, actions=pop_mpls:0x0800, goto_table:2</code>
+          mpls_bos=1, actions=pop_mpls:0x0800, goto_table:2</code>
         </li>
       </ul>
     </field>