All of lore.kernel.org
 help / color / mirror / Atom feed
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>,
	Anton Vorontsov <anton@enomsg.org>,
	Colin Cross <ccross@android.com>,
	Heikki Krogerus <heikki.krogerus@linux.intel.com>,
	Johan Hovold <johan@kernel.org>,
	Kees Cook <keescook@chromium.org>, Peter Rosin <peda@axentia.se>,
	Richard Cochran <richardcochran@gmail.com>,
	Tony Luck <tony.luck@intel.com>,
	linux-usb@vger.kernel.org, linuxppc-dev@lists.ozlabs.org,
	netdev@vger.kernel.org
Subject: [PATCH v3 00/30]Change wildcards on ABI files
Date: Thu, 16 Sep 2021 10:59:27 +0200	[thread overview]
Message-ID: <cover.1631782432.git.mchehab+huawei@kernel.org> (raw)

The ABI files are meant to be parsed via a script (scripts/get_abi.pl).

A new improvement on it will allow it to help to detect if an ABI description
is missing, or if the What: field won't match the actual location of the symbol.

In order for get_abi.pl to convert What: into regex, changes are needed on
existing ABI files, as the conversion should not be ambiguous.

One alternative would be to convert everything into regexes, but this
would generate a huge amount of patches/changes. So, instead, let's
touch only the ABI files that aren't following the de-facto wildcard 
standards already found on most of the ABI files, e. g.:

	/.../
	*
	<foo>
	(option1|option2)
	X
	Y
	Z
	[0-9] (and variants)

---

v3:
   - Added a new patch for sysfs-class-rapidio;
   - sysfs-class-typec had a typo, instead of a wildcard;
   - sysfs-bus-soundwire-* had some additional What to be fixed;
   - added some reviewed-by/acked-by tags.

v2:
   - Added several patches to address uppercase "N" meaning
     as a wildcard.

Mauro Carvalho Chehab (30):
  ABI: sysfs-bus-usb: better document variable argument
  ABI: sysfs-tty: better document module name parameter
  ABI: sysfs-kernel-slab: use a wildcard for the cache name
  ABI: security: fix location for evm and ima_policy
  ABI: sysfs-class-tpm: use wildcards for pcr-* nodes
  ABI: sysfs-bus-rapidio: use wildcards on What definitions
  ABI: sysfs-class-cxl: place "not in a guest" at description
  ABI: sysfs-class-devfreq-event: use the right wildcards on What
  ABI: sysfs-class-mic: use the right wildcards on What definitions
  ABI: pstore: Fix What field
  ABI:  fix a typo on a What field
  ABI: sysfs-ata: use a proper wildcard for ata_*
  ABI: sysfs-class-infiniband: use wildcards on What definitions
  ABI: sysfs-bus-pci: use wildcards on What definitions
  ABI: -master: use wildcards on What definitions
  ABI: sysfs-bus-soundwire-slave: use wildcards on What definitions
  ABI: sysfs-class-gnss: use wildcards on What definitions
  ABI: sysfs-class-mei: use wildcards on What definitions
  ABI: sysfs-class-mux: use wildcards on What definitions
  ABI: sysfs-class-pwm: use wildcards on What definitions
  ABI: sysfs-class-rc: use wildcards on What definitions
  ABI: sysfs-class-rc-nuvoton: use wildcards on What definitions
  ABI: sysfs-class-uwb_rc: use wildcards on What definitions
  ABI: sysfs-class-uwb_rc-wusbhc: use wildcards on What definitions
  ABI: sysfs-devices-platform-dock: use wildcards on What definitions
  ABI: sysfs-devices-system-cpu: use wildcards on What definitions
  ABI: sysfs-firmware-efi-esrt: use wildcards on What definitions
  ABI: sysfs-platform-sst-atom: use wildcards on What definitions
  ABI: sysfs-ptp: use wildcards on What definitions
  ABI: sysfs-class-rapidio: use wildcards on What definitions

 .../ABI/stable/sysfs-class-infiniband         | 64 ++++++-------
 Documentation/ABI/stable/sysfs-class-tpm      |  2 +-
 Documentation/ABI/testing/evm                 |  4 +-
 Documentation/ABI/testing/ima_policy          |  2 +-
 Documentation/ABI/testing/pstore              |  3 +-
 Documentation/ABI/testing/sysfs-ata           |  2 +-
 Documentation/ABI/testing/sysfs-bus-pci       |  2 +-
 Documentation/ABI/testing/sysfs-bus-rapidio   | 32 +++----
 .../ABI/testing/sysfs-bus-soundwire-master    | 20 ++--
 .../ABI/testing/sysfs-bus-soundwire-slave     | 60 ++++++------
 Documentation/ABI/testing/sysfs-bus-usb       | 16 ++--
 Documentation/ABI/testing/sysfs-class-cxl     | 15 ++-
 .../ABI/testing/sysfs-class-devfreq-event     | 12 +--
 Documentation/ABI/testing/sysfs-class-gnss    |  2 +-
 Documentation/ABI/testing/sysfs-class-mei     | 18 ++--
 Documentation/ABI/testing/sysfs-class-mic     | 24 ++---
 Documentation/ABI/testing/sysfs-class-mux     |  2 +-
 Documentation/ABI/testing/sysfs-class-pwm     | 20 ++--
 Documentation/ABI/testing/sysfs-class-rapidio |  4 +-
 Documentation/ABI/testing/sysfs-class-rc      | 14 +--
 .../ABI/testing/sysfs-class-rc-nuvoton        |  2 +-
 Documentation/ABI/testing/sysfs-class-typec   |  2 +-
 Documentation/ABI/testing/sysfs-class-uwb_rc  | 26 ++---
 .../ABI/testing/sysfs-class-uwb_rc-wusbhc     | 10 +-
 .../ABI/testing/sysfs-devices-platform-dock   | 10 +-
 .../ABI/testing/sysfs-devices-system-cpu      | 16 ++--
 .../ABI/testing/sysfs-firmware-efi-esrt       | 16 ++--
 Documentation/ABI/testing/sysfs-kernel-slab   | 94 +++++++++----------
 .../ABI/testing/sysfs-platform-sst-atom       |  2 +-
 Documentation/ABI/testing/sysfs-ptp           | 30 +++---
 Documentation/ABI/testing/sysfs-tty           | 32 +++----
 31 files changed, 282 insertions(+), 276 deletions(-)

-- 
2.31.1



WARNING: multiple messages have this Message-ID (diff)
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: Heikki Krogerus <heikki.krogerus@linux.intel.com>,
	Kees Cook <keescook@chromium.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	netdev@vger.kernel.org,
	Richard Cochran <richardcochran@gmail.com>,
	Anton Vorontsov <anton@enomsg.org>,
	linux-kernel@vger.kernel.org, Johan Hovold <johan@kernel.org>,
	Tony Luck <tony.luck@intel.com>, Colin Cross <ccross@android.com>,
	linux-usb@vger.kernel.org, linuxppc-dev@lists.ozlabs.org,
	Peter Rosin <peda@axentia.se>
Subject: [PATCH v3 00/30]Change wildcards on ABI files
Date: Thu, 16 Sep 2021 10:59:27 +0200	[thread overview]
Message-ID: <cover.1631782432.git.mchehab+huawei@kernel.org> (raw)

The ABI files are meant to be parsed via a script (scripts/get_abi.pl).

A new improvement on it will allow it to help to detect if an ABI description
is missing, or if the What: field won't match the actual location of the symbol.

In order for get_abi.pl to convert What: into regex, changes are needed on
existing ABI files, as the conversion should not be ambiguous.

One alternative would be to convert everything into regexes, but this
would generate a huge amount of patches/changes. So, instead, let's
touch only the ABI files that aren't following the de-facto wildcard 
standards already found on most of the ABI files, e. g.:

	/.../
	*
	<foo>
	(option1|option2)
	X
	Y
	Z
	[0-9] (and variants)

---

v3:
   - Added a new patch for sysfs-class-rapidio;
   - sysfs-class-typec had a typo, instead of a wildcard;
   - sysfs-bus-soundwire-* had some additional What to be fixed;
   - added some reviewed-by/acked-by tags.

v2:
   - Added several patches to address uppercase "N" meaning
     as a wildcard.

Mauro Carvalho Chehab (30):
  ABI: sysfs-bus-usb: better document variable argument
  ABI: sysfs-tty: better document module name parameter
  ABI: sysfs-kernel-slab: use a wildcard for the cache name
  ABI: security: fix location for evm and ima_policy
  ABI: sysfs-class-tpm: use wildcards for pcr-* nodes
  ABI: sysfs-bus-rapidio: use wildcards on What definitions
  ABI: sysfs-class-cxl: place "not in a guest" at description
  ABI: sysfs-class-devfreq-event: use the right wildcards on What
  ABI: sysfs-class-mic: use the right wildcards on What definitions
  ABI: pstore: Fix What field
  ABI:  fix a typo on a What field
  ABI: sysfs-ata: use a proper wildcard for ata_*
  ABI: sysfs-class-infiniband: use wildcards on What definitions
  ABI: sysfs-bus-pci: use wildcards on What definitions
  ABI: -master: use wildcards on What definitions
  ABI: sysfs-bus-soundwire-slave: use wildcards on What definitions
  ABI: sysfs-class-gnss: use wildcards on What definitions
  ABI: sysfs-class-mei: use wildcards on What definitions
  ABI: sysfs-class-mux: use wildcards on What definitions
  ABI: sysfs-class-pwm: use wildcards on What definitions
  ABI: sysfs-class-rc: use wildcards on What definitions
  ABI: sysfs-class-rc-nuvoton: use wildcards on What definitions
  ABI: sysfs-class-uwb_rc: use wildcards on What definitions
  ABI: sysfs-class-uwb_rc-wusbhc: use wildcards on What definitions
  ABI: sysfs-devices-platform-dock: use wildcards on What definitions
  ABI: sysfs-devices-system-cpu: use wildcards on What definitions
  ABI: sysfs-firmware-efi-esrt: use wildcards on What definitions
  ABI: sysfs-platform-sst-atom: use wildcards on What definitions
  ABI: sysfs-ptp: use wildcards on What definitions
  ABI: sysfs-class-rapidio: use wildcards on What definitions

 .../ABI/stable/sysfs-class-infiniband         | 64 ++++++-------
 Documentation/ABI/stable/sysfs-class-tpm      |  2 +-
 Documentation/ABI/testing/evm                 |  4 +-
 Documentation/ABI/testing/ima_policy          |  2 +-
 Documentation/ABI/testing/pstore              |  3 +-
 Documentation/ABI/testing/sysfs-ata           |  2 +-
 Documentation/ABI/testing/sysfs-bus-pci       |  2 +-
 Documentation/ABI/testing/sysfs-bus-rapidio   | 32 +++----
 .../ABI/testing/sysfs-bus-soundwire-master    | 20 ++--
 .../ABI/testing/sysfs-bus-soundwire-slave     | 60 ++++++------
 Documentation/ABI/testing/sysfs-bus-usb       | 16 ++--
 Documentation/ABI/testing/sysfs-class-cxl     | 15 ++-
 .../ABI/testing/sysfs-class-devfreq-event     | 12 +--
 Documentation/ABI/testing/sysfs-class-gnss    |  2 +-
 Documentation/ABI/testing/sysfs-class-mei     | 18 ++--
 Documentation/ABI/testing/sysfs-class-mic     | 24 ++---
 Documentation/ABI/testing/sysfs-class-mux     |  2 +-
 Documentation/ABI/testing/sysfs-class-pwm     | 20 ++--
 Documentation/ABI/testing/sysfs-class-rapidio |  4 +-
 Documentation/ABI/testing/sysfs-class-rc      | 14 +--
 .../ABI/testing/sysfs-class-rc-nuvoton        |  2 +-
 Documentation/ABI/testing/sysfs-class-typec   |  2 +-
 Documentation/ABI/testing/sysfs-class-uwb_rc  | 26 ++---
 .../ABI/testing/sysfs-class-uwb_rc-wusbhc     | 10 +-
 .../ABI/testing/sysfs-devices-platform-dock   | 10 +-
 .../ABI/testing/sysfs-devices-system-cpu      | 16 ++--
 .../ABI/testing/sysfs-firmware-efi-esrt       | 16 ++--
 Documentation/ABI/testing/sysfs-kernel-slab   | 94 +++++++++----------
 .../ABI/testing/sysfs-platform-sst-atom       |  2 +-
 Documentation/ABI/testing/sysfs-ptp           | 30 +++---
 Documentation/ABI/testing/sysfs-tty           | 32 +++----
 31 files changed, 282 insertions(+), 276 deletions(-)

-- 
2.31.1



             reply	other threads:[~2021-09-16  9:00 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-16  8:59 Mauro Carvalho Chehab [this message]
2021-09-16  8:59 ` [PATCH v3 00/30]Change wildcards on ABI files Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 01/30] ABI: sysfs-bus-usb: better document variable argument Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 02/30] ABI: sysfs-tty: better document module name parameter Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 03/30] ABI: sysfs-kernel-slab: use a wildcard for the cache name Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 04/30] ABI: security: fix location for evm and ima_policy Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 05/30] ABI: sysfs-class-tpm: use wildcards for pcr-* nodes Mauro Carvalho Chehab
2021-09-16 15:59   ` Jarkko Sakkinen
2021-09-16 16:00     ` Jarkko Sakkinen
2021-09-16 16:06       ` Greg Kroah-Hartman
2021-09-16  8:59 ` [PATCH v3 06/30] ABI: sysfs-bus-rapidio: use wildcards on What definitions Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 07/30] ABI: sysfs-class-cxl: place "not in a guest" at description Mauro Carvalho Chehab
2021-09-16  8:59   ` Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 08/30] ABI: sysfs-class-devfreq-event: use the right wildcards on What Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 09/30] ABI: sysfs-class-mic: use the right wildcards on What definitions Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 10/30] ABI: pstore: Fix What field Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 11/30] ABI: sysfs-class-typec: fix a typo on a " Mauro Carvalho Chehab
2021-09-16 11:47   ` Heikki Krogerus
2021-09-16  8:59 ` [PATCH v3 12/30] ABI: sysfs-ata: use a proper wildcard for ata_* Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 13/30] ABI: sysfs-class-infiniband: use wildcards on What definitions Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 14/30] ABI: sysfs-bus-pci: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 15/30] ABI: sysfs-bus-soundwire-master: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 16/30] ABI: sysfs-bus-soundwire-slave: " Mauro Carvalho Chehab
2021-09-16 16:36   ` Pierre-Louis Bossart
2021-09-16 16:47     ` Mauro Carvalho Chehab
2021-10-01  4:37       ` Vinod Koul
2021-10-01  4:36   ` Vinod Koul
2021-09-16  8:59 ` [PATCH v3 17/30] ABI: sysfs-class-gnss: " Mauro Carvalho Chehab
2021-09-20  9:40   ` Johan Hovold
2021-09-16  8:59 ` [PATCH v3 18/30] ABI: sysfs-class-mei: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 19/30] ABI: sysfs-class-mux: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 20/30] ABI: sysfs-class-pwm: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 21/30] ABI: sysfs-class-rc: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 22/30] ABI: sysfs-class-rc-nuvoton: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 23/30] ABI: sysfs-class-uwb_rc: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 24/30] ABI: sysfs-class-uwb_rc-wusbhc: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 25/30] ABI: sysfs-devices-platform-dock: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 26/30] ABI: sysfs-devices-system-cpu: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 27/30] ABI: sysfs-firmware-efi-esrt: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 28/30] ABI: sysfs-platform-sst-atom: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 29/30] ABI: sysfs-ptp: " Mauro Carvalho Chehab
2021-09-16  8:59 ` [PATCH v3 30/30] ABI: sysfs-class-rapidio: " Mauro Carvalho Chehab

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.1631782432.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=anton@enomsg.org \
    --cc=ccross@android.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=heikki.krogerus@linux.intel.com \
    --cc=johan@kernel.org \
    --cc=keescook@chromium.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=netdev@vger.kernel.org \
    --cc=peda@axentia.se \
    --cc=richardcochran@gmail.com \
    --cc=tony.luck@intel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.