Re: [RFC net-next 1/3] skbuff: add a basic intro doc
From: Jonathan Corbet <corbet@lwn.net>
Date: 2022-03-24 14:16:52
Also in:
linux-doc
Jakub Kicinski [off-list ref] writes:
Add basic skb documentation. It's mostly an intro to the subsequent patches - it would looks strange if we documented advanced topics without covering the basics in any way. Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Glad to see improved docs! One nit...
quoted hunk ↗ jump to hunk
Documentation/networking/skbuff.rst | 25 ++++++++++++++++++ include/linux/skbuff.h | 40 +++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) create mode 100644 Documentation/networking/skbuff.rstdiff --git a/Documentation/networking/skbuff.rst b/Documentation/networking/skbuff.rst new file mode 100644 index 000000000000..7c6be64f486a --- /dev/null +++ b/Documentation/networking/skbuff.rst@@ -0,0 +1,25 @@ +.. SPDX-License-Identifier: GPL-2.0 + +struct sk_buff +============== + +:c:type:`struct sk_buff` is the main networking structure representing +a packet.
You shouldn't need :c:type: here, our magic stuff should see "struct sk_buff" and generate the cross reference. Of course, it will be a highly local reference in this case... Thanks, jon