Skip to content

net_shaper: fix kernel-doc rendering

Karl Mehltretter linux-doc lkml netdev 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest2 patches 5 repliesIn review 1 of 2 applied
  2. v11 patch 4 repliesSuperseded

Changes in v2 from the cover letter

- 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

Patches in v2 1 of 2 applied

#Subject and filesSizeRepliesApplied
1/2net_shaper: fix kernel-doc list indentationinclude/net/net_shaper.h+5 -41 replyApplied
2/2docs: kerneldoc.py: preserve headings in kernel-doc outputDocumentation/sphinx/kerneldoc.py+2 -12 replies

Reviews trailers per patch

All 2 patches have a Reviewed-by or Acked-by.

PatchRandy Dunlap
1/2R-b T-b
2/2A-b T-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

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

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

Signature · 1 line
2.53.0