Skip to content

ABI: update files to reduce the documentation gap

Mauro Carvalho Chehab linux-doc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest17 patches 9 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/17ABI: stable/sysfs-module: better document modulesDocumentation/ABI/stable/sysfs-module+7 -60 replies
2/17ABI: stable/sysfs-module: document version and srcversionDocumentation/ABI/stable/sysfs-module+12 -00 replies
3/17ABI: testing/sysfs-module: document initstateDocumentation/ABI/testing/sysfs-module+7 -00 replies
4/17ABI: sysfs-devices-power: document some RPM statisticsDocumentation/ABI/testing/sysfs-devices-power+14 -00 replies
5/17ABI: sysfs-devices: add /dev ABIDocumentation/ABI/stable/sysfs-devices+7 -00 replies
6/17ABI: sysfs-bus-pci: add documentation for modaliasDocumentation/ABI/testing/sysfs-bus-pci+18 -02 replies
7/17ABI: o2cb: add an obsolete file for /sys/o2cbDocumentation/ABI/obsolete/o2cb Documentation/ABI/stable/o2cb+12 -10 replies
8/17ABI: sysfs-kernel-slab: Document some statsDocumentation/ABI/testing/sysfs-kernel-slab+21 -00 replies
9/17ABI: sysfs-devices-power: add some debug sysfs filesDocumentation/ABI/testing/sysfs-devices-power+22 -00 replies
10/17ABI: sysfs-bus-pci: add a alternative What fieldsDocumentation/ABI/testing/sysfs-bus-pci+4 -02 replies
11/17ABI: sysfs-class-bdi: use What: to describe each propertyDocumentation/ABI/testing/sysfs-class-bdi+21 -90 replies
12/17ABI: sysfs-bus-mdio: add alternate What for mdio symbolsDocumentation/ABI/testing/sysfs-bus-mdio+9 -00 replies
13/17ABI: sysfs-bus-usb: use a wildcard for interface name on WhatDocumentation/ABI/testing/sysfs-bus-usb+1 -10 replies
14/17ABI: sysfs-bus-usb: add missing sysfs fieldsDocumentation/ABI/testing/sysfs-bus-usb+274 -00 replies
15/17ABI: obsolete/sysfs-bus-iio: add some missing blank linesDocumentation/ABI/obsolete/sysfs-bus-iio+4 -00 replies
16/17ABI: sysfs-driver-ufs: Add another What for platform driversDocumentation/ABI/testing/sysfs-driver-ufs+126 -04 replies
17/17ABI: sysfs-bus-platform: add modalias descriptionDocumentation/ABI/testing/sysfs-bus-platform+12 -01 reply

Reviews trailers per patch

2 of 17 patches have a Reviewed-by or Acked-by.

PatchBjorn HelgaasBarry Song
1/17
2/17
3/17
4/17
5/17
6/17A-b
7/17
8/17
9/17
10/17
11/17
12/17
13/17
14/17
15/17
16/17
17/17A-b

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

Read the v1 thread

Cover letter [PATCH 00/17] ABI: update files to reduce the documentation gap

On a recent work, "scripts/get_abi.pl" gained a command that validates if the files under /sys are properly described inside Documentation/ABI.

It does that by comparing the What: fields inside Documentation/ABI with the entries under /sysfs.

This series addresses some of the most commonly missed nodes (in terms of the number of reported occurencies).

This series is based on next-20210927. Most patches are independent from the other patches on this series.

-

After this series, the number of warnings reduced a lot on my desktop (a NUC8i7HNK):

  $  time ./scripts/get_abi.pl undefined |sort >undef && cat undef|perl -ne 'print "$1\n" if (m#.*/(\S+) not found#)'|sort|uniq -c|sort -nr >undefined_symbols &&  wc -l undef undefined_symbols
  real	0m6,583s
  user	0m5,841s
  sys	0m0,718s
    6663 undef
     774 undefined_symbols
    7437 total

Please notice that this script runs millions of regular expressions in order to do such match. So, while here is is running on 6 seconds, it could take a lot more time on a bigger machine.

Mauro Carvalho Chehab (17):
ABI: stable/sysfs-module: better document modules
ABI: stable/sysfs-module: document version and srcversion
ABI: testing/sysfs-module: document initstate
ABI: sysfs-devices-power: document some RPM statistics
ABI: sysfs-devices: add /dev ABI
ABI: sysfs-bus-pci: add documentation for modalias
ABI: o2cb: add an obsolete file for /sys/o2cb
ABI: sysfs-kernel-slab: Document some stats
ABI: sysfs-devices-power: add some debug sysfs files
ABI: sysfs-bus-pci: add a alternative What fields
ABI: sysfs-class-bdi: use What: to describe each property
ABI: sysfs-bus-mdio: add alternate What for mdio symbols
ABI: sysfs-bus-usb: use a wildcard for interface name on What
ABI: sysfs-bus-usb: add missing sysfs fields
ABI: obsolete/sysfs-bus-iio: add some missing blank lines
ABI: sysfs-driver-ufs: Add another What for platform drivers
ABI: sysfs-bus-platform: add modalias description

 Documentation/ABI/obsolete/o2cb               |  11 +
 Documentation/ABI/obsolete/sysfs-bus-iio      |   4 +
 Documentation/ABI/stable/o2cb                 |   2 +-
 Documentation/ABI/stable/sysfs-devices        |   7 +
 Documentation/ABI/stable/sysfs-module         |  25 +-
 Documentation/ABI/testing/sysfs-bus-mdio      |   9 +
 Documentation/ABI/testing/sysfs-bus-pci       |  22 ++
 Documentation/ABI/testing/sysfs-bus-platform  |  12 +
 Documentation/ABI/testing/sysfs-bus-usb       | 276 +++++++++++++++++-
 Documentation/ABI/testing/sysfs-class-bdi     |  30 +-
 Documentation/ABI/testing/sysfs-devices-power |  36 +++
 Documentation/ABI/testing/sysfs-driver-ufs    | 126 ++++++++
 Documentation/ABI/testing/sysfs-kernel-slab   |  21 ++
 Documentation/ABI/testing/sysfs-module        |   7 +
 14 files changed, 571 insertions(+), 17 deletions(-)
 create mode 100644 Documentation/ABI/obsolete/o2cb
Signature · 1 line
2.31.1