[PATCH net-next v2 0/2] net_shaper: fix kernel-doc rendering

Karl Mehltretter <[email protected]>
Newsgroups gmane.linux.documentation,gmane.linux.network,gmane.linux.kernel
Message-ID <[email protected]>
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/[email protected]/

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
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.