Skip to content

Documentation/ABI: platform/x86: Sphinx warning fixes

Hans de Goede linux-pm lkml platform-driver-x86 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest4 patches 4 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4Documentation/ABI: sysfs-driver-intel_sdsi: Fix sphinx warningsDocumentation/ABI/testing/sysfs-driver-intel_sdsi+10 -81 reply
2/4Documentation/ABI: sysfs-class-firmware-attributes: Fix Sphinx errorsDocumentation/ABI/testing/sysfs-class-firmware-attributes+23 -191 reply
3/4Documentation/ABI: sysfs-class-firmware-attributes: Misc. cleanupsDocumentation/ABI/testing/sysfs-class-firmware-attributes+3 -31 reply
4/4Documentation/ABI: sysfs-class-power: Fix Sphinx errorDocumentation/ABI/testing/sysfs-class-power+1 -01 reply

Reviews trailers per patch

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

Read the v1 thread

Cover letter [PATCH 0/4] Documentation/ABI: platform/x86: Sphinx warning fixes

Hi All,

After Stephen reported some Sphinx warnings for files under Documentation/ABI/testing, I had to first figure out how to reproduce these. It turns out that to regenerate the htmldocs for files under Documentation/ABI/testing once has to run:

touch Documentation/admin-guide/abi-testing.rst && make htmldocs

This turned up warnings in multiple sysfs ABI files for platform/x86 drivers, as well as in some new functionality in sysfs-class-power, which was merged through the platform-drivers-x86 tree.

I plan to merge this series through the platform-drivers-x86 tree and send this out in a fixed pull-req to Linus once 5.18-rc1 is out.

Regards,

Hans

p.s.

platform-drivers-x86 authors, for future patch submissions touching files under Documentation/ABI/testing please run:

touch Documentation/admin-guide/abi-testing.rst && make htmldocs

and make sure no warnings are introduced.

Hans de Goede (4):
Documentation/ABI: sysfs-driver-intel_sdsi: Fix sphinx warnings Documentation/ABI: sysfs-class-firmware-attributes: Fix Sphinx errors Documentation/ABI: sysfs-class-firmware-attributes: Misc. cleanups Documentation/ABI: sysfs-class-power: Fix Sphinx error

 .../testing/sysfs-class-firmware-attributes   | 48 ++++++++++---------
 Documentation/ABI/testing/sysfs-class-power   |  1 +
 .../ABI/testing/sysfs-driver-intel_sdsi       | 18 +++----
 3 files changed, 37 insertions(+), 30 deletions(-)
Signature · 1 line
2.35.1