Commit 16ed4545 authored by Vyshnav Ajith's avatar Vyshnav Ajith Committed by Jakub Kicinski
Browse files

docs: net: bareudp: fix spelling and grammar mistakes 



The BareUDP documentation had several grammar and spelling mistakes,
making it harder to read. This patch fixes those errors to improve
clarity and readability for developers.

Signed-off-by: default avatarVyshnav Ajith <puthen1977@gmail.com>
Link: https://patch.msgid.link/20241121224827.12293-1-puthen1977@gmail.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent eedcad2f

Documentation/networking/bareudp.rst

+6 −5
Original line number Diff line number Diff line
@@ -6,16 +6,17 @@ Bare UDP Tunnelling Module Documentation 


There are various L3 encapsulation standards using UDP being discussed to

leverage the UDP based load balancing capability of different networks.

MPLSoUDP (__ https://tools.ietf.org/html/rfc7510) is one among them.

MPLSoUDP (https://tools.ietf.org/html/rfc7510) is one among them.



The Bareudp tunnel module provides a generic L3 encapsulation support for

tunnelling different L3 protocols like MPLS, IP, NSH etc. inside a UDP tunnel.



Special Handling

----------------



The bareudp device supports special handling for MPLS & IP as they can have

multiple ethertypes.

MPLS procotcol can have ethertypes ETH_P_MPLS_UC  (unicast) & ETH_P_MPLS_MC (multicast).

The MPLS protocol can have ethertypes ETH_P_MPLS_UC (unicast) & ETH_P_MPLS_MC (multicast).

IP protocol can have ethertypes ETH_P_IP (v4) & ETH_P_IPV6 (v6).

This special handling can be enabled only for ethertypes ETH_P_IP & ETH_P_MPLS_UC

with a flag called multiproto mode.
@@ -52,7 +53,7 @@ be enabled explicitly with the "multiproto" flag. 
3) Device Usage



The bareudp device could be used along with OVS or flower filter in TC.

The OVS or TC flower layer must set the tunnel information in SKB dst field before

sending packet buffer to the bareudp device for transmission. On reception the

bareudp device extracts and stores the tunnel information in SKB dst field before

The OVS or TC flower layer must set the tunnel information in the SKB dst field before

sending the packet buffer to the bareudp device for transmission. On reception, the

bareUDP device extracts and stores the tunnel information in the SKB dst field before

passing the packet buffer to the network stack.