From: Willem de Bruijn <willemdebruijn.kernel@gmail.com>
To: Sangmin Lee <45sangmin99@gmail.com>, netdev@vger.kernel.org
Cc: "David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@kernel.org>,
Jakub Kicinski <kuba@kernel.org>,
Paolo Abeni <pabeni@redhat.com>,
Simon Horman <horms@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Shuah Khan <skhan@linuxfoundation.org>,
Randy Dunlap <rdunlap@infradead.org>,
David Ahern <dsahern@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH net-next] docs: networking: correct skb_shared_info field reference
Date: Thu, 19 Nov 2026 16:25:45 -0500 [thread overview]
Message-ID: <willemdebruijn.kernel.d6d50443276@gmail.com> (raw)
In-Reply-To: <20261119164351.49040-1-45sangmin99@gmail.com>
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.
prev parent reply other threads:[~2026-11-19 21:25 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
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 message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=willemdebruijn.kernel.d6d50443276@gmail.com \
--to=willemdebruijn.kernel@gmail.com \
--cc=45sangmin99@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=dsahern@kernel.org \
--cc=edumazet@kernel.org \
--cc=horms@kernel.org \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.