From: Karl Mehltretter <kmehltretter@gmail.com>
To: "David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>
Cc: Karl Mehltretter <kmehltretter@gmail.com>,
Simon Horman <horms@kernel.org>,
netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH net-next] net_shaper: fix net_shaper_ops kernel-doc
Date: Thu, 13 Aug 2026 21:21:31 +0200 [thread overview]
Message-ID: <20260813192131.21254-1-kmehltretter@gmail.com> (raw)
Everything from the "Driver ops vs uAPI" heading onward is dropped from
the rendered net_shaper_ops documentation. Older Docutils versions do so
silently, while Docutils 0.22 reports the nested headings and adjacent
list as invalid.
Use bold labels and correct the list indentation.
Fixes: 16812d9674d4 ("net_shaper: remove incorrect comment about group leaves")
Fixes: 26bc4cfb1737 ("net_shaper: clarify the kernel API / comments")
Assisted-by: Codex:gpt-5.6-sol
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
The omission is visible in the current linux-next generated documentation:
https://www.kernel.org/doc/html/next/networking/kapi.html#c.net_shaper_ops
Tested with Sphinx 9.1.0 and Docutils 0.22.4:
make SPHINXDIRS=networking htmldocs
include/net/net_shaper.h | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/include/net/net_shaper.h b/include/net/net_shaper.h
index 05cb625b0fe54..a2eb616a19fd0 100644
--- a/include/net/net_shaper.h
+++ b/include/net/net_shaper.h
@@ -73,20 +73,21 @@ struct net_shaper {
* Each shaper is uniquely identified within the device with a 'handle'
* comprising the shaper scope and a scope-specific id.
*
- * Driver ops vs uAPI
- * ------------------
+ * **Driver ops vs uAPI**
+ *
* Members of the driver ops mirror the Netlink uAPI but driver calls do not
* map 1:1 to user calls. Drivers need to be careful when assuming that calls
* disallowed at the uAPI level will never be made at the driver level.
* The shaper core performs automatic reparenting and cleanup, generating
* additional calls. Notably:
- * - @group calls in the driver facing API may have nodes as leaves (user is
- * only allowed to construct groups with queues as leaves)
- * - @group calls may update leaf's parent if the parent is about
- * to be removed (re-parenting nodes explicitly is not supported in the uAPI)
*
- * Implicit creation
- * -----------------
+ * - @group calls in the driver facing API may have nodes as leaves (user is
+ * only allowed to construct groups with queues as leaves)
+ * - @group calls may update leaf's parent if the parent is about
+ * to be removed (re-parenting nodes explicitly is not supported in the uAPI)
+ *
+ * **Implicit creation**
+ *
* Shapers are created implicitly, meaning that @set and @group operations
* are called both for existing and new shapers. The driver has to infer
* whether the operation is an update or a creation by tracking the handles.
base-commit: 3205699d79f262412c1be7fc1c04066610d3cd52
--
2.53.0
reply other threads:[~2026-08-13 19:21 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20260813192131.21254-1-kmehltretter@gmail.com \
--to=kmehltretter@gmail.com \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=horms@kernel.org \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox