From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
Adrian Hunter <adrian.hunter@intel.com>,
Alan Stern <stern@rowland.harvard.edu>,
Amey Narkhede <ameynarkhede03@gmail.com>,
Avri Altman <avri.altman@wdc.com>,
Barry Song <song.bao.hua@hisilicon.com>,
Bean Huo <beanhuo@micron.com>,
Bjorn Helgaas <bhelgaas@google.com>,
Can Guo <cang@codeaurora.org>, Carlos Bilbao <bilbao@vt.edu>,
Cezary Rojewski <cezary.rojewski@intel.com>,
Christoph Lameter <cl@linux.com>,
Daejun Park <daejun7.park@samsung.com>,
David Windsor <dave@nullcore.net>,
Dominik Brodowski <linux@dominikbrodowski.net>,
Geert Uytterhoeven <geert+renesas@glider.be>,
Heikki Krogerus <heikki.krogerus@linux.intel.com>,
Jonathan Cameron <Jonathan.Cameron@huawei.com>,
Kees Cook <keescook@chromium.org>,
Leon Romanovsky <leon@kernel.org>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Marc Zyngier <maz@kernel.org>,
Maximilian Luz <luzmaximilian@gmail.com>,
Niklas Schnelle <schnelle@linux.ibm.com>,
Oded Gabbay <oded.gabbay@gmail.com>,
Pekka Enberg <penberg@kernel.org>,
Rajat Jain <rajatja@google.com>,
Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
Suzuki K Poulose <suzuki.poulose@arm.com>,
Thomas Gleixner <tglx@linutronix.de>, Tom Rix <trix@redhat.com>,
Vaibhav Jain <vaibhav@linux.ibm.com>
Subject: [PATCH 00/17] ABI: update files to reduce the documentation gap
Date: Mon, 27 Sep 2021 15:59:33 +0200 [thread overview]
Message-ID: <cover.1632750608.git.mchehab+huawei@kernel.org> (raw)
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
--
2.31.1
next reply other threads:[~2021-09-27 14:00 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-27 13:59 Mauro Carvalho Chehab [this message]
2021-09-27 13:59 ` [PATCH 01/17] ABI: stable/sysfs-module: better document modules Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 02/17] ABI: stable/sysfs-module: document version and srcversion Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 03/17] ABI: testing/sysfs-module: document initstate Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 04/17] ABI: sysfs-devices-power: document some RPM statistics Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 05/17] ABI: sysfs-devices: add /dev ABI Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 06/17] ABI: sysfs-bus-pci: add documentation for modalias Mauro Carvalho Chehab
2021-09-28 10:48 ` Greg Kroah-Hartman
2021-09-28 11:48 ` Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 07/17] ABI: o2cb: add an obsolete file for /sys/o2cb Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 08/17] ABI: sysfs-kernel-slab: Document some stats Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 09/17] ABI: sysfs-devices-power: add some debug sysfs files Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 10/17] ABI: sysfs-bus-pci: add a alternative What fields Mauro Carvalho Chehab
2021-09-28 18:34 ` Bjorn Helgaas
2021-09-28 22:07 ` Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 11/17] ABI: sysfs-class-bdi: use What: to describe each property Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 12/17] ABI: sysfs-bus-mdio: add alternate What for mdio symbols Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 13/17] ABI: sysfs-bus-usb: use a wildcard for interface name on What Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 14/17] ABI: sysfs-bus-usb: add missing sysfs fields Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 15/17] ABI: obsolete/sysfs-bus-iio: add some missing blank lines Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 16/17] ABI: sysfs-driver-ufs: Add another What for platform drivers Mauro Carvalho Chehab
2021-09-29 6:32 ` Avri Altman
2021-09-29 7:03 ` Greg Kroah-Hartman
2021-09-29 7:23 ` Avri Altman
2021-09-29 7:39 ` Greg Kroah-Hartman
2021-09-27 13:59 ` [PATCH 17/17] ABI: sysfs-bus-platform: add modalias description Mauro Carvalho Chehab
2021-09-27 21:00 ` Barry Song
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1632750608.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=Jonathan.Cameron@huawei.com \
--cc=adrian.hunter@intel.com \
--cc=ameynarkhede03@gmail.com \
--cc=avri.altman@wdc.com \
--cc=beanhuo@micron.com \
--cc=bhelgaas@google.com \
--cc=bilbao@vt.edu \
--cc=cang@codeaurora.org \
--cc=cezary.rojewski@intel.com \
--cc=cl@linux.com \
--cc=corbet@lwn.net \
--cc=daejun7.park@samsung.com \
--cc=dave@nullcore.net \
--cc=geert+renesas@glider.be \
--cc=gregkh@linuxfoundation.org \
--cc=heikki.krogerus@linux.intel.com \
--cc=keescook@chromium.org \
--cc=leon@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@dominikbrodowski.net \
--cc=lukas.bulwahn@gmail.com \
--cc=luzmaximilian@gmail.com \
--cc=martin.petersen@oracle.com \
--cc=maz@kernel.org \
--cc=oded.gabbay@gmail.com \
--cc=penberg@kernel.org \
--cc=rajatja@google.com \
--cc=rjw@rjwysocki.net \
--cc=schnelle@linux.ibm.com \
--cc=song.bao.hua@hisilicon.com \
--cc=srinivas.kandagatla@linaro.org \
--cc=stern@rowland.harvard.edu \
--cc=suzuki.poulose@arm.com \
--cc=tglx@linutronix.de \
--cc=trix@redhat.com \
--cc=vaibhav@linux.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).