Netdev List
 help / color / mirror / Atom feed
* [PATCH net-next] docs: networking: correct skb_shared_info field reference
@ 2026-11-19 16:43 Sangmin Lee
  2026-11-19 21:25 ` Willem de Bruijn
  0 siblings, 1 reply; 2+ messages in thread
From: Sangmin Lee @ 2026-11-19 16:43 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

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.

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")
Signed-off-by: Sangmin Lee <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..e66adf19a 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: 9068e05d35f3b02a802f520e664032f802bcd2e9
-- 
2.50.1 (Apple Git-155)


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH net-next] docs: networking: correct skb_shared_info field reference
  2026-11-19 16:43 [PATCH net-next] docs: networking: correct skb_shared_info field reference Sangmin Lee
@ 2026-11-19 21:25 ` Willem de Bruijn
  0 siblings, 0 replies; 2+ messages in thread
From: Willem de Bruijn @ 2026-11-19 21:25 UTC (permalink / raw)
  To: Sangmin Lee, 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

Sangmin Lee wrote:
> 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.
> 
> 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")
> Signed-off-by: Sangmin Lee <45sangmin99@gmail.com>

Reviewed-by: Willem de Bruijn <willemb@google.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..e66adf19a 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).

small nit:

    The `&struct.member` syntax is only converted inside kernel-doc
    comments in C files. In a plain .rst file the `&` is printed literally,
    so the HTML shows "&skb_shared_info.dataref". Since you're touching the
    line anyway, match line 18 (:c:member:`sk_buff.users`) or line 19
    (``sk_buff.users != 1``), e.g.:
  
        ``skb_shared_info.dataref`` indicates the number of skbs pointing at the same
  
    The :c:member: form won't link, because struct skb_shared_info has no
    kernel-doc, so the ``literal`` form is the safer choice.



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-11-19 21:25 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-19 16:43 [PATCH net-next] docs: networking: correct skb_shared_info field reference Sangmin Lee
2026-11-19 21:25 ` Willem de Bruijn

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