Skip to content

Fix some issues with ABI files

Mauro Carvalho Chehab linux-doc lkml platform-driver-x86 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest7 patches 3 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/7scripts: get_abi.pl: create a valid ReST with duplicated tagsscripts/get_abi.pl+1 -00 replies
2/7ABI: sysfs-platform-dell-privacy-wmi: correct ABI entriesDocumentation/ABI/testing/sysfs-platform-dell-privacy-wmi+38 -221 reply
3/7ABI: sysfs-platform-dptf: Add tables markup to a tableDocumentation/ABI/testing/sysfs-platform-dptf+4 -00 replies
4/7ABI: configfs-usb-gadget-uac1: fix a broken tableDocumentation/ABI/testing/configfs-usb-gadget-uac1+24 -180 replies
5/7ABI: configfs-usb-gadget-uac2: fix a broken tableDocumentation/ABI/testing/configfs-usb-gadget-uac2+25 -180 replies
6/7ABI: sysfs-devices-removable: make a table valid as ReST markupDocumentation/ABI/testing/sysfs-devices-removable+5 -30 replies
7/7ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for ReSTDocumentation/ABI/testing/sysfs-platform-intel-pmc+2 -02 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/7] Fix some issues with ABI files

Hi Greg,

All patches in this series are independent each other. This series is based on today's next (next-20210927).

As you know, I've been busy those days adding a new feature for get_abi.pl to identify missing documentation. While doing that, I noticed several issues at the ABI files on "make htmldocs". This series address them, and it is independent from the other patches for get_abi.pl.

Patch 1 is actually a small improvement to get_abi.pl, addressing an issue when there are multiple definitions for the same ABI symbol. While this is not allowed, and produce warnings, there are still 3 occurrences:

./scripts/get_abi.pl validate
Warning: /sys/bus/iio/devices/iio:deviceX/fault_ovuv is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856:14 Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:0
Warning: /sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:12 Documentation/ABI/testing/sysfs-bus-iio:1911
Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 Documentation/ABI/testing/sysfs-bus-iio:91

Once those got fixed, perhaps a future patch could make get_abi.pl to generate an error causing the compilation to break, if WERROR is defined.

Anyway, it is better to to make the script more reliable anyway, specially since it is just one extra line of code.

Patches 2-7 fix random warnings introduced by new patches.

Regards,
Mauro

Mauro Carvalho Chehab (7):
scripts: get_abi.pl: create a valid ReST with duplicated tags
ABI: sysfs-platform-dell-privacy-wmi: correct ABI entries
ABI: sysfs-platform-dptf: Add tables markup to a table
ABI: configfs-usb-gadget-uac1: fix a broken table
ABI: configfs-usb-gadget-uac2: fix a broken table
ABI: sysfs-devices-removable: make a table valid as ReST markup
ABI: sysfs-platform-intel-pmc: add blank lines to make it valid for
ReST

 .../ABI/testing/configfs-usb-gadget-uac1      | 42 +++++++------
 .../ABI/testing/configfs-usb-gadget-uac2      | 43 +++++++------
 .../ABI/testing/sysfs-devices-removable       |  8 ++-
 .../testing/sysfs-platform-dell-privacy-wmi   | 60 ++++++++++++-------
 Documentation/ABI/testing/sysfs-platform-dptf |  4 ++
 .../ABI/testing/sysfs-platform-intel-pmc      |  2 +
 scripts/get_abi.pl                            |  1 +
 7 files changed, 99 insertions(+), 61 deletions(-)
Signature · 1 line
2.31.1