Skip to content

Some fixes for ABI documentation

Mauro Carvalho Chehab linux-doc lkml 1 version New

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest5 patches 0 repliesNew

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5docs: ABI: sysfs-driver-dma-ioatdma: what starts with /sysDocumentation/ABI/stable/sysfs-driver-dma-ioatdma+5 -50 replies
2/5docs: ABI: sysfs-class-net: fix a typoDocumentation/ABI/testing/sysfs-class-net+1 -10 replies
3/5docs: leds: index.rst: add a missing fileDocumentation/leds/index.rst+1 -00 replies
4/5scripts: get_abi.pl: Don't let ABI files to create subtitlesscripts/get_abi.pl+6 -00 replies
5/5scripts: get_api.pl: Add sub-titles to ABI outputscripts/get_abi.pl+17 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/5] Some fixes for ABI documentation

Hi Greg,

This small series contain fixes against Kernel 5.10-rc2.

It is meant to address the issue reported by Randy, with regards to some "SEVERE" docutils warnings that it is causing the build to fail for him.

I was not able to reproduce the bug myself, but fixing it is easy.

While here, I noticed a few typos at a few sysfs ABI entries. The first two patches address them.

The third patch fixes a small issue: I added a new ReST file at the ABI series, but the index file didn't receive the update.

The forth patch is the one that actually fix the reported issue.

While here, I added small change at get_abi.pl, for it to generate some index entries for the symbols. That sounded to me a natural change after having patch 4 removing some ABI indexes. This patch should make life easier for people looking for a symbol inside the ABI books.

Mauro Carvalho Chehab (5):
docs: ABI: sysfs-driver-dma-ioatdma: what starts with /sys
docs: ABI: sysfs-class-net: fix a typo
docs: leds: index.rst: add a missing file
scripts: get_abi.pl: Don't let ABI files to create subtitles
scripts: get_api.pl: Add sub-titles to ABI output

 .../ABI/stable/sysfs-driver-dma-ioatdma       | 10 ++++----
 Documentation/ABI/testing/sysfs-class-net     |  2 +-
 Documentation/leds/index.rst                  |  1 +
 scripts/get_abi.pl                            | 23 +++++++++++++++++++
 4 files changed, 30 insertions(+), 6 deletions(-)
Signature · 1 line
2.26.2