Linux Documentation
 help / color / mirror / Atom feed
* [PATCH net-next v2] docs: networking: correct skb_shared_info field reference
@ 2026-11-20 17:11 Sangmin Lee
  0 siblings, 0 replies; only message in thread
From: Sangmin Lee @ 2026-11-20 17:11 UTC (permalink / raw)
  To: netdev
  Cc: David S. Miller, Eric Dumazet, Jakub Kicinski, Paolo Abeni,
	Simon Horman, Jonathan Corbet, Shuah Khan, Randy Dunlap,
	David Ahern, linux-doc, linux-kernel, Willem de Bruijn

The skbuff documentation refers to skb_shared_info.refcount,
but struct skb_shared_info has no such member. The actual
field is skb_shared_info.dataref.

Correct the reference to match the structure definition. Use an inline
literal so the field name renders without a leading ampersand.

The discrepancy was identified with assistance from
GPT-6.2-Astra (xhigh) and manually verified against
include/linux/skbuff.h.

Codex built the affected page with Sphinx and verified the corrected
field name in the HTML output.

Fixes: ddccc9ef5599 ("skbuff: add a basic intro doc")
Reviewed-by: Willem de Bruijn <willemb@google.com>
Signed-off-by: Sangmin Lee <45sangmin99@gmail.com>
---
Thank you, Willem.

I've always wanted to contribute to open source, but I was hesitant
to jump in. Your thoughtful review made me feel welcome and excited
to keep contributing.

Changes in v2:

- Use an inline literal for skb_shared_info.dataref so Sphinx renders
  the field name without the leading ampersand.

v1: https://lore.kernel.org/netdev/20261119164351.49040-1-45sangmin99@gmail.com/

 Documentation/networking/skbuff.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/networking/skbuff.rst b/Documentation/networking/skbuff.rst
index 94681523e..15a9a9399 100644
--- a/Documentation/networking/skbuff.rst
+++ b/Documentation/networking/skbuff.rst
@@ -21,7 +21,7 @@ to as shared skbs (see skb_shared()).
 
 skb_clone() allows for fast duplication of skbs. None of the data buffers
 get copied, but caller gets a new metadata struct (struct sk_buff).
-&skb_shared_info.refcount indicates the number of skbs pointing at the same
+``skb_shared_info.dataref`` indicates the number of skbs pointing at the same
 packet data (i.e. clones).
 
 dataref and headerless skbs

base-commit: 362917b0b26bd16587d41a37f5fd1c252099a73c
-- 
2.50.1 (Apple Git-155)


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2026-11-20 17:16 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-20 17:11 [PATCH net-next v2] docs: networking: correct skb_shared_info field reference Sangmin Lee

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox