diff mbox series

[net-next] vxlan: vxlan_rcv(): Update comment to inlucde ipv6

Message ID 20250205114448.113966-1-znscnchen@gmail.com (mailing list archive)
State New
Delegated to: Netdev Maintainers
Headers show
Series [net-next] vxlan: vxlan_rcv(): Update comment to inlucde ipv6 | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for 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: petrm@nvidia.com
netdev/build_clang success Errors and warnings before: 2 this patch: 2
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: 1 this patch: 1
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 8 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 success net-next-2025-02-05--12-00 (tests: 868)

Commit Message

Ted Chen Feb. 5, 2025, 11:44 a.m. UTC
Update the comment to indicate that both net/ipv4/udp.c and net/ipv6/udp.c
invoke vxlan_rcv() to process packets.

The comment aligns with that for vxlan_err_lookup().

Cc: Ido Schimmel <idosch@idosch.org>
Signed-off-by: Ted Chen <znscnchen@gmail.com>
---
 drivers/net/vxlan/vxlan_core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Nikolay Aleksandrov Feb. 5, 2025, 12:12 p.m. UTC | #1
On 2/5/25 13:44, Ted Chen wrote:
> Update the comment to indicate that both net/ipv4/udp.c and net/ipv6/udp.c
> invoke vxlan_rcv() to process packets.
> 
> The comment aligns with that for vxlan_err_lookup().
> 
> Cc: Ido Schimmel <idosch@idosch.org>
> Signed-off-by: Ted Chen <znscnchen@gmail.com>
> ---
>  drivers/net/vxlan/vxlan_core.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/vxlan/vxlan_core.c b/drivers/net/vxlan/vxlan_core.c
> index 5ef40ac816cc..8bdf91d1fdfe 100644
> --- a/drivers/net/vxlan/vxlan_core.c
> +++ b/drivers/net/vxlan/vxlan_core.c
> @@ -1684,7 +1684,7 @@ static bool vxlan_ecn_decapsulate(struct vxlan_sock *vs, void *oiph,
>  	return err <= 1;
>  }
>  
> -/* Callback from net/ipv4/udp.c to receive packets */
> +/* Callback from net/ipv{4,6}/udp.c to receive packets */
>  static int vxlan_rcv(struct sock *sk, struct sk_buff *skb)
>  {
>  	struct vxlan_vni_node *vninode = NULL;

Your subject has a typo
s/inlucde/include

IMO these comments are unnecessary, encap_rcv callers are trivial to find.

Cheers,
 Nik
Ted Chen Feb. 5, 2025, 12:40 p.m. UTC | #2
On Wed, Feb 05, 2025 at 02:12:50PM +0200, Nikolay Aleksandrov wrote:
> On 2/5/25 13:44, Ted Chen wrote:
> > Update the comment to indicate that both net/ipv4/udp.c and net/ipv6/udp.c
> > invoke vxlan_rcv() to process packets.
> > 
> > The comment aligns with that for vxlan_err_lookup().
> > 
> > Cc: Ido Schimmel <idosch@idosch.org>
> > Signed-off-by: Ted Chen <znscnchen@gmail.com>
> > ---
> >  drivers/net/vxlan/vxlan_core.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/net/vxlan/vxlan_core.c b/drivers/net/vxlan/vxlan_core.c
> > index 5ef40ac816cc..8bdf91d1fdfe 100644
> > --- a/drivers/net/vxlan/vxlan_core.c
> > +++ b/drivers/net/vxlan/vxlan_core.c
> > @@ -1684,7 +1684,7 @@ static bool vxlan_ecn_decapsulate(struct vxlan_sock *vs, void *oiph,
> >  	return err <= 1;
> >  }
> >  
> > -/* Callback from net/ipv4/udp.c to receive packets */
> > +/* Callback from net/ipv{4,6}/udp.c to receive packets */
> >  static int vxlan_rcv(struct sock *sk, struct sk_buff *skb)
> >  {
> >  	struct vxlan_vni_node *vninode = NULL;
> 
> Your subject has a typo
> s/inlucde/include
Oops. Sorry for that.
 
> IMO these comments are unnecessary, encap_rcv callers are trivial to find.
I'm fine with either way. No comment is better than a wrong comment.
Please let me know if I need to send a new version to correct the subject or
remove the comments for both vxlan_rcv() and vxlan_err_lookup().
Nikolay Aleksandrov Feb. 5, 2025, 12:48 p.m. UTC | #3
On 2/5/25 14:40, Ted Chen wrote:
> On Wed, Feb 05, 2025 at 02:12:50PM +0200, Nikolay Aleksandrov wrote:
>> On 2/5/25 13:44, Ted Chen wrote:
>>> Update the comment to indicate that both net/ipv4/udp.c and net/ipv6/udp.c
>>> invoke vxlan_rcv() to process packets.
>>>
>>> The comment aligns with that for vxlan_err_lookup().
>>>
>>> Cc: Ido Schimmel <idosch@idosch.org>
>>> Signed-off-by: Ted Chen <znscnchen@gmail.com>
>>> ---
>>>  drivers/net/vxlan/vxlan_core.c | 2 +-
>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/net/vxlan/vxlan_core.c b/drivers/net/vxlan/vxlan_core.c
>>> index 5ef40ac816cc..8bdf91d1fdfe 100644
>>> --- a/drivers/net/vxlan/vxlan_core.c
>>> +++ b/drivers/net/vxlan/vxlan_core.c
>>> @@ -1684,7 +1684,7 @@ static bool vxlan_ecn_decapsulate(struct vxlan_sock *vs, void *oiph,
>>>  	return err <= 1;
>>>  }
>>>  
>>> -/* Callback from net/ipv4/udp.c to receive packets */
>>> +/* Callback from net/ipv{4,6}/udp.c to receive packets */
>>>  static int vxlan_rcv(struct sock *sk, struct sk_buff *skb)
>>>  {
>>>  	struct vxlan_vni_node *vninode = NULL;
>>
>> Your subject has a typo
>> s/inlucde/include
> Oops. Sorry for that.
>  
>> IMO these comments are unnecessary, encap_rcv callers are trivial to find.
> I'm fine with either way. No comment is better than a wrong comment.
> Please let me know if I need to send a new version to correct the subject or
> remove the comments for both vxlan_rcv() and vxlan_err_lookup().
> 

Up to you, I don't have a strong preference. You have to wait 24 hours
before posting another version anyway, so you have time to decide. :)
diff mbox series

Patch

diff --git a/drivers/net/vxlan/vxlan_core.c b/drivers/net/vxlan/vxlan_core.c
index 5ef40ac816cc..8bdf91d1fdfe 100644
--- a/drivers/net/vxlan/vxlan_core.c
+++ b/drivers/net/vxlan/vxlan_core.c
@@ -1684,7 +1684,7 @@  static bool vxlan_ecn_decapsulate(struct vxlan_sock *vs, void *oiph,
 	return err <= 1;
 }
 
-/* Callback from net/ipv4/udp.c to receive packets */
+/* Callback from net/ipv{4,6}/udp.c to receive packets */
 static int vxlan_rcv(struct sock *sk, struct sk_buff *skb)
 {
 	struct vxlan_vni_node *vninode = NULL;