diff mbox series

[net-next] tcp: add missing htmldocs for skb->ll_node and sk->defer_list

Message ID 20211118015729.994115-1-eric.dumazet@gmail.com (mailing list archive)
State Accepted
Commit df6160deb3debe6f964c16349f9431157ff67dda
Delegated to: Netdev Maintainers
Headers show
Series [net-next] tcp: add missing htmldocs for skb->ll_node and sk->defer_list | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Single patches do not need cover letters
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 6000 this patch: 6000
netdev/cc_maintainers warning 1 maintainers not CCed: jonathan.lemon@gmail.com
netdev/build_clang success Errors and warnings before: 1043 this patch: 1043
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 6155 this patch: 6155
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 14 lines checked
netdev/kdoc success Errors and warnings before: 2 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Eric Dumazet Nov. 18, 2021, 1:57 a.m. UTC 
From: Eric Dumazet <edumazet@google.com>

Add missing entries to fix these "make htmldocs" warnings.

./include/linux/skbuff.h:953: warning: Function parameter or member 'll_node' not described in 'sk_buff'
./include/net/sock.h:540: warning: Function parameter or member 'defer_list' not described in 'sock'

Fixes: f35f821935d8 ("tcp: defer skb freeing after socket lock is released")
Signed-off-by: Eric Dumazet <edumazet@google.com>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
---
 include/linux/skbuff.h | 1 +
 include/net/sock.h     | 1 +
 2 files changed, 2 insertions(+)

Comments

patchwork-bot+netdevbpf@kernel.org Nov. 18, 2021, 12:10 p.m. UTC | #1 
Hello:

This patch was applied to netdev/net-next.git (master)
by David S. Miller <davem@davemloft.net>:

On Wed, 17 Nov 2021 17:57:29 -0800 you wrote:
> From: Eric Dumazet <edumazet@google.com>
> 
> Add missing entries to fix these "make htmldocs" warnings.
> 
> ./include/linux/skbuff.h:953: warning: Function parameter or member 'll_node' not described in 'sk_buff'
> ./include/net/sock.h:540: warning: Function parameter or member 'defer_list' not described in 'sock'
> 
> [...]

Here is the summary with links:
  - [net-next] tcp: add missing htmldocs for skb->ll_node and sk->defer_list
    https://git.kernel.org/netdev/net-next/c/df6160deb3de

You are awesome, thank you!
diff mbox series

Patch

diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
index b8b806512e1615fad2bc9935baba3fff14996012..100fd604fbc9a32180a6f43626249d19bf415c4f 100644
--- a/include/linux/skbuff.h
+++ b/include/linux/skbuff.h
@@ -627,6 +627,7 @@  typedef unsigned char *sk_buff_data_t;
  *		for retransmit timer
  *	@rbnode: RB tree node, alternative to next/prev for netem/tcp
  *	@list: queue head
+ *	@ll_node: anchor in an llist (eg socket defer_list)
  *	@sk: Socket we are owned by
  *	@ip_defrag_offset: (aka @sk) alternate use of @sk, used in
  *		fragmentation management
diff --git a/include/net/sock.h b/include/net/sock.h
index f09c0c4736c46a18b820949ba3c8ea4e7c6fee57..a79fc772324e5da7b9f489de2e06698695d3e7d7 100644
--- a/include/net/sock.h
+++ b/include/net/sock.h
@@ -292,6 +292,7 @@  struct bpf_local_storage;
   *	@sk_pacing_shift: scaling factor for TCP Small Queues
   *	@sk_lingertime: %SO_LINGER l_linger setting
   *	@sk_backlog: always used with the per-socket spinlock held
+  *	@defer_list: head of llist storing skbs to be freed
   *	@sk_callback_lock: used with the callbacks in the end of this struct
   *	@sk_error_queue: rarely used
   *	@sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,