diff mbox series

[net-next] net: add kdoc for dev->fib_nh_head

Message ID 20241008093848.355522-1-edumazet@google.com (mailing list archive)
State Not Applicable
Delegated to: Netdev Maintainers
Headers show
Series [net-next] net: add kdoc for dev->fib_nh_head | 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, async
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: 43 this patch: 43
netdev/build_tools success Errors and warnings before: 0 (+2) this patch: 0 (+2)
netdev/cc_maintainers fail 2 blamed authors not CCed: kuniyu@amazon.com dsahern@kernel.org; 2 maintainers not CCed: kuniyu@amazon.com dsahern@kernel.org
netdev/build_clang success Errors and warnings before: 83 this patch: 83
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 Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 4144 this patch: 4144
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 7 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 22 this patch: 22
netdev/source_inline success Was 0 now: 0
netdev/contest fail net-next-2024-10-08--12-00 (tests: 773)

Commit Message

Eric Dumazet Oct. 8, 2024, 9:38 a.m. UTC 
Simon reported that fib_nh_head kdoc was missing.

Fixes: a3f5f4c2f9b6 ("ipv4: remove fib_info_devhash[]")
Closes: https://lore.kernel.org/netdev/20241007140850.GC32733@kernel.org/raw
Reported-by: Simon Horman <horms@kernel.org>
Signed-off-by: Eric Dumazet <edumazet@google.com>
---
 include/linux/netdevice.h | 1 +
 1 file changed, 1 insertion(+)

Comments

Eric Dumazet Oct. 8, 2024, 9:48 a.m. UTC | #1 
On Tue, Oct 8, 2024 at 11:38 AM Eric Dumazet <edumazet@google.com> wrote:
>
> Simon reported that fib_nh_head kdoc was missing.
>
> Fixes: a3f5f4c2f9b6 ("ipv4: remove fib_info_devhash[]")
> Closes: https://lore.kernel.org/netdev/20241007140850.GC32733@kernel.org/raw
> Reported-by: Simon Horman <horms@kernel.org>
> Signed-off-by: Eric Dumazet <edumazet@google.com>
> ---
>  include/linux/netdevice.h | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
> index 3baf8e539b6f33caaf83961c4cf619b799e5e41d..b5a5a2b555cda76ce2c0b3b3b2124b34409d1d69 100644
> --- a/include/linux/netdevice.h
> +++ b/include/linux/netdevice.h
> @@ -1842,6 +1842,7 @@ enum netdev_reg_state {
>   *     @tipc_ptr:      TIPC specific data
>   *     @atalk_ptr:     AppleTalk link
>   *     @ip_ptr:        IPv4 specific data
> + *     @fib_nh_head:   list of fib_nh attached to this device
>   *     @ip6_ptr:       IPv6 specific data
>   *     @ax25_ptr:      AX.25 specific data
>   *     @ieee80211_ptr: IEEE 802.11 specific data, assign before registering
> --
> 2.47.0.rc0.187.ge670bccf7e-goog
>

Hmm... maybe not needed, I saw Jakub added inline:

/** @fib_nh_head: nexthops associated with this netdev */

Thanks !
Simon Horman Oct. 9, 2024, 12:07 p.m. UTC | #2 
On Tue, Oct 08, 2024 at 11:48:12AM +0200, Eric Dumazet wrote:
> On Tue, Oct 8, 2024 at 11:38 AM Eric Dumazet <edumazet@google.com> wrote:
> >
> > Simon reported that fib_nh_head kdoc was missing.
> >
> > Fixes: a3f5f4c2f9b6 ("ipv4: remove fib_info_devhash[]")
> > Closes: https://lore.kernel.org/netdev/20241007140850.GC32733@kernel.org/raw
> > Reported-by: Simon Horman <horms@kernel.org>
> > Signed-off-by: Eric Dumazet <edumazet@google.com>
> > ---
> >  include/linux/netdevice.h | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
> > index 3baf8e539b6f33caaf83961c4cf619b799e5e41d..b5a5a2b555cda76ce2c0b3b3b2124b34409d1d69 100644
> > --- a/include/linux/netdevice.h
> > +++ b/include/linux/netdevice.h
> > @@ -1842,6 +1842,7 @@ enum netdev_reg_state {
> >   *     @tipc_ptr:      TIPC specific data
> >   *     @atalk_ptr:     AppleTalk link
> >   *     @ip_ptr:        IPv4 specific data
> > + *     @fib_nh_head:   list of fib_nh attached to this device
> >   *     @ip6_ptr:       IPv6 specific data
> >   *     @ax25_ptr:      AX.25 specific data
> >   *     @ieee80211_ptr: IEEE 802.11 specific data, assign before registering
> > --
> > 2.47.0.rc0.187.ge670bccf7e-goog
> >
> 
> Hmm... maybe not needed, I saw Jakub added inline:
> 
> /** @fib_nh_head: nexthops associated with this netdev */

Thanks, I see that too.

Sorry for the noise.
diff mbox series

Patch

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index 3baf8e539b6f33caaf83961c4cf619b799e5e41d..b5a5a2b555cda76ce2c0b3b3b2124b34409d1d69 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1842,6 +1842,7 @@  enum netdev_reg_state {
  *	@tipc_ptr:	TIPC specific data
  *	@atalk_ptr:	AppleTalk link
  *	@ip_ptr:	IPv4 specific data
+ *	@fib_nh_head:	list of fib_nh attached to this device
  *	@ip6_ptr:	IPv6 specific data
  *	@ax25_ptr:	AX.25 specific data
  *	@ieee80211_ptr:	IEEE 802.11 specific data, assign before registering