diff mbox series

[REPOST] docs: networking: Remove VLAN_TAG_PRESENT from openvswitch doc

Message ID 20250203113012.14943-1-ak.karis@gmail.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series [REPOST] docs: networking: Remove VLAN_TAG_PRESENT from openvswitch doc | expand

Checks

Context Check Description
netdev/series_format warning Single patches do not need cover letters; Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers warning 1 maintainers not CCed: horms@kernel.org
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 11 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest warning net-next-2025-02-03--18-00 (tests: 535)

Commit Message

Andreas Karis Feb. 3, 2025, 11:30 a.m. UTC
Since commit 0c4b2d370514 ("net: remove VLAN_TAG_PRESENT"), the kernel
no longer uses VLAN_TAG_PRESENT.
Update the openvswitch documentation which still contained an outdated
reference to VLAN_TAG_PRESENT.

Signed-off-by: Andreas Karis <ak.karis@gmail.com>
---
 Documentation/networking/openvswitch.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Michał Mirosław Feb. 3, 2025, 1:29 p.m. UTC | #1
On Mon, Feb 03, 2025 at 12:30:12PM +0100, Andreas Karis wrote:
> Since commit 0c4b2d370514 ("net: remove VLAN_TAG_PRESENT"), the kernel
> no longer uses VLAN_TAG_PRESENT.
> Update the openvswitch documentation which still contained an outdated
> reference to VLAN_TAG_PRESENT.

Hi, it would be best to extend this doc saying that the CFI bit is not
usable in openvswitch (unlike in other parts of kernel).

Nevertheless,
Acked-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>

> 
> Signed-off-by: Andreas Karis <ak.karis@gmail.com>
> ---
>  Documentation/networking/openvswitch.rst | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/networking/openvswitch.rst b/Documentation/networking/openvswitch.rst
> index 1a8353dbf1b6..8d2bbcb92286 100644
> --- a/Documentation/networking/openvswitch.rst
> +++ b/Documentation/networking/openvswitch.rst
> @@ -230,9 +230,8 @@ an all-zero-bits vlan and an empty encap attribute, like this::
>      eth(...), eth_type(0x8100), vlan(0), encap()
>  
>  Unlike a TCP packet with source and destination ports 0, an
> -all-zero-bits VLAN TCI is not that rare, so the CFI bit (aka
> -VLAN_TAG_PRESENT inside the kernel) is ordinarily set in a vlan
> -attribute expressly to allow this situation to be distinguished.
> +all-zero-bits VLAN TCI is not that rare, so the CFI bit is ordinarily set
> +in a vlan attribute expressly to allow this situation to be distinguished.
>  Thus, the flow key in this second example unambiguously indicates a
>  missing or malformed VLAN TCI.
>  
> -- 
> 2.48.1
>
Ilya Maximets Feb. 3, 2025, 1:41 p.m. UTC | #2
On 2/3/25 14:29, Michał Mirosław wrote:
> On Mon, Feb 03, 2025 at 12:30:12PM +0100, Andreas Karis wrote:
>> Since commit 0c4b2d370514 ("net: remove VLAN_TAG_PRESENT"), the kernel
>> no longer uses VLAN_TAG_PRESENT.
>> Update the openvswitch documentation which still contained an outdated
>> reference to VLAN_TAG_PRESENT.
> 
> Hi, it would be best to extend this doc saying that the CFI bit is not
> usable in openvswitch (unlike in other parts of kernel).

FWIW, sch_frag does the same thing.  So, it's not only openvswitch.
Though, yes, sch_frag is probably doing that because TC mimics what
OVS does.

> 
> Nevertheless,
> Acked-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>
> 
>>
>> Signed-off-by: Andreas Karis <ak.karis@gmail.com>
>> ---
>>  Documentation/networking/openvswitch.rst | 5 ++---
>>  1 file changed, 2 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/networking/openvswitch.rst b/Documentation/networking/openvswitch.rst
>> index 1a8353dbf1b6..8d2bbcb92286 100644
>> --- a/Documentation/networking/openvswitch.rst
>> +++ b/Documentation/networking/openvswitch.rst
>> @@ -230,9 +230,8 @@ an all-zero-bits vlan and an empty encap attribute, like this::
>>      eth(...), eth_type(0x8100), vlan(0), encap()
>>  
>>  Unlike a TCP packet with source and destination ports 0, an
>> -all-zero-bits VLAN TCI is not that rare, so the CFI bit (aka
>> -VLAN_TAG_PRESENT inside the kernel) is ordinarily set in a vlan
>> -attribute expressly to allow this situation to be distinguished.
>> +all-zero-bits VLAN TCI is not that rare, so the CFI bit is ordinarily set
>> +in a vlan attribute expressly to allow this situation to be distinguished.
>>  Thus, the flow key in this second example unambiguously indicates a
>>  missing or malformed VLAN TCI.
>>  
>> -- 
>> 2.48.1
>>
>
diff mbox series

Patch

diff --git a/Documentation/networking/openvswitch.rst b/Documentation/networking/openvswitch.rst
index 1a8353dbf1b6..8d2bbcb92286 100644
--- a/Documentation/networking/openvswitch.rst
+++ b/Documentation/networking/openvswitch.rst
@@ -230,9 +230,8 @@  an all-zero-bits vlan and an empty encap attribute, like this::
     eth(...), eth_type(0x8100), vlan(0), encap()
 
 Unlike a TCP packet with source and destination ports 0, an
-all-zero-bits VLAN TCI is not that rare, so the CFI bit (aka
-VLAN_TAG_PRESENT inside the kernel) is ordinarily set in a vlan
-attribute expressly to allow this situation to be distinguished.
+all-zero-bits VLAN TCI is not that rare, so the CFI bit is ordinarily set
+in a vlan attribute expressly to allow this situation to be distinguished.
 Thus, the flow key in this second example unambiguously indicates a
 missing or malformed VLAN TCI.