All of lore.kernel.org
 help / color / mirror / Atom feed
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>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Karl Mehltretter <kmehltretter@gmail.com>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Simon Horman <horms@kernel.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	netdev@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH net-next v2 0/2] net_shaper: fix kernel-doc rendering
Date: Sat, 15 Aug 2026 03:32:27 +0200	[thread overview]
Message-ID: <cover.1786751700.git.kmehltretter@gmail.com> (raw)

The net_shaper_ops documentation contains a malformed ReST list and
exposes a kerneldoc.py title-context bug which drops valid headings.
Fix the list first because the parser correction makes it visible. The
parser fix also restores three Xe DRM RAS headings already in mainline.

Tested with Sphinx 9.1.0:

  Docutils 0.21.2 and 0.22.4:
    make SPHINXDIRS=networking htmldocs

  Docutils 0.22.4:
    make htmldocs

The full output differed only in the intended net_shaper and Xe rendering
and checkout-path-dependent build artifacts.

Changes from v1:
- fix heading parsing instead of replacing headings with bold labels
- split the list and parser fixes
- add diagnostics and point the Fixes tag at the kerneldoc.py regression

v1: https://lore.kernel.org/netdev/20260813192131.21254-1-kmehltretter@gmail.com/

Karl Mehltretter (2):
  net_shaper: fix kernel-doc list indentation
  docs: kerneldoc.py: preserve headings in kernel-doc output

 Documentation/sphinx/kerneldoc.py | 3 ++-
 include/net/net_shaper.h          | 9 +++++----
 2 files changed, 7 insertions(+), 5 deletions(-)


base-commit: 3205699d79f262412c1be7fc1c04066610d3cd52
-- 
2.53.0

             reply	other threads:[~2026-08-15  1:33 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-15  1:32 Karl Mehltretter [this message]
2026-08-15  1:32 ` [PATCH net-next v2 1/2] net_shaper: fix kernel-doc list indentation Karl Mehltretter
2026-08-15  1:32 ` [PATCH net-next v2 2/2] docs: kerneldoc.py: preserve headings in kernel-doc output Karl Mehltretter

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=cover.1786751700.git.kmehltretter@gmail.com \
    --to=kmehltretter@gmail.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=horms@kernel.org \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@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.