From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 96D30C4332F for ; Mon, 27 Sep 2021 14:00:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 807E261002 for ; Mon, 27 Sep 2021 14:00:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234776AbhI0OBm (ORCPT ); Mon, 27 Sep 2021 10:01:42 -0400 Received: from mail.kernel.org ([198.145.29.99]:48028 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234712AbhI0OBf (ORCPT ); Mon, 27 Sep 2021 10:01:35 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id 4F5DD6113A; Mon, 27 Sep 2021 13:59:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1632751197; bh=QIR/AZvKaUB5YUKjxRfW+Aj0W2BpAPheeO7XHo4T6d8=; h=From:To:Cc:Subject:Date:From; b=faBzzLhMoCv55p/1SGPbfuO2mqFBV1uKCBpZcOJkQ77e2bYcI/V+I0Du5QuiA6Yam sjj/K0e3D/bRS6Uie5RoaylzqP4FUtCtfaIFh21pHSw8Gqt7w6nfJxK4VJjBPtfMWd YqoJgkMeTtSoclP2CIO5w/A/ReGXGnABObb79y+lILdhCyYNDyF3V/abPst3VA5ZY6 1CBtrN/XiDboAFW5HhSUY1YINX8mj4Mw1PR2uAIYt+Zmse6klPgwRgDWe81TnGW1RI R5uAPTevKG0aVcJeGITlfDb9rJVGU12O63FfTyYbX4fPLnUwU9UIulUADlpph0kxQC +Nm3Gcai5fBXQ== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1mUrAh-000AtX-6i; Mon, 27 Sep 2021 15:59:55 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Greg Kroah-Hartman Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , "Martin K. Petersen" , "Rafael J. Wysocki" , Adrian Hunter , Alan Stern , Amey Narkhede , Avri Altman , Barry Song , Bean Huo , Bjorn Helgaas , Can Guo , Carlos Bilbao , Cezary Rojewski , Christoph Lameter , Daejun Park , David Windsor , Dominik Brodowski , Geert Uytterhoeven , Heikki Krogerus , Jonathan Cameron , Kees Cook , Leon Romanovsky , Lukas Bulwahn , Marc Zyngier , Maximilian Luz , Niklas Schnelle , Oded Gabbay , Pekka Enberg , Rajat Jain , Srinivas Kandagatla , Suzuki K Poulose , Thomas Gleixner , Tom Rix , Vaibhav Jain Subject: [PATCH 00/17] ABI: update files to reduce the documentation gap Date: Mon, 27 Sep 2021 15:59:33 +0200 Message-Id: X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org 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