* [PATCH v3 00/30]Change wildcards on ABI files
@ 2021-09-16 8:59 Mauro Carvalho Chehab
2021-09-16 8:59 ` [PATCH v3 29/30] ABI: sysfs-ptp: use wildcards on What definitions Mauro Carvalho Chehab
0 siblings, 1 reply; 2+ messages in thread
From: Mauro Carvalho Chehab @ 2021-09-16 8:59 UTC (permalink / raw)
To: Linux Doc Mailing List, Greg Kroah-Hartman
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Anton Vorontsov, Colin Cross, Heikki Krogerus, Johan Hovold,
Kees Cook, Peter Rosin, Richard Cochran, Tony Luck, linux-usb,
linuxppc-dev, netdev
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
^ permalink raw reply [flat|nested] 2+ messages in thread* [PATCH v3 29/30] ABI: sysfs-ptp: use wildcards on What definitions 2021-09-16 8:59 [PATCH v3 00/30]Change wildcards on ABI files Mauro Carvalho Chehab @ 2021-09-16 8:59 ` Mauro Carvalho Chehab 0 siblings, 0 replies; 2+ messages in thread From: Mauro Carvalho Chehab @ 2021-09-16 8:59 UTC (permalink / raw) To: Linux Doc Mailing List, Greg Kroah-Hartman Cc: Mauro Carvalho Chehab, Jonathan Corbet, Richard Cochran, linux-kernel, netdev An "N" upper letter is not a wildcard, nor can easily be identified by script, specially since the USB sysfs define things like. bNumInterfaces. Use, instead, <N>, in order to let script/get_abi.pl to convert it into a Regex. Acked-by: Richard Cochran <richardcochran@gmail•com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel•org> --- Documentation/ABI/testing/sysfs-ptp | 30 ++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp index d378f57c1b73..9c317ac7c47a 100644 --- a/Documentation/ABI/testing/sysfs-ptp +++ b/Documentation/ABI/testing/sysfs-ptp @@ -6,7 +6,7 @@ Description: providing a standardized interface to the ancillary features of PTP hardware clocks. -What: /sys/class/ptp/ptpN/ +What: /sys/class/ptp/ptp<N>/ Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -14,7 +14,7 @@ Description: hardware clock registered into the PTP class driver subsystem. -What: /sys/class/ptp/ptpN/clock_name +What: /sys/class/ptp/ptp<N>/clock_name Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -25,7 +25,7 @@ Description: MAC based ones. The string does not necessarily have to be any kind of unique id. -What: /sys/class/ptp/ptpN/max_adjustment +What: /sys/class/ptp/ptp<N>/max_adjustment Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -33,42 +33,42 @@ Description: frequency adjustment value (a positive integer) in parts per billion. -What: /sys/class/ptp/ptpN/max_vclocks +What: /sys/class/ptp/ptp<N>/max_vclocks Date: May 2021 Contact: Yangbo Lu <yangbo.lu@nxp•com> Description: This file contains the maximum number of ptp vclocks. Write integer to re-configure it. -What: /sys/class/ptp/ptpN/n_alarms +What: /sys/class/ptp/ptp<N>/n_alarms Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: This file contains the number of periodic or one shot alarms offer by the PTP hardware clock. -What: /sys/class/ptp/ptpN/n_external_timestamps +What: /sys/class/ptp/ptp<N>/n_external_timestamps Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: This file contains the number of external timestamp channels offered by the PTP hardware clock. -What: /sys/class/ptp/ptpN/n_periodic_outputs +What: /sys/class/ptp/ptp<N>/n_periodic_outputs Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: This file contains the number of programmable periodic output channels offered by the PTP hardware clock. -What: /sys/class/ptp/ptpN/n_pins +What: /sys/class/ptp/ptp<N>/n_pins Date: March 2014 Contact: Richard Cochran <richardcochran@gmail•com> Description: This file contains the number of programmable pins offered by the PTP hardware clock. -What: /sys/class/ptp/ptpN/n_vclocks +What: /sys/class/ptp/ptp<N>/n_vclocks Date: May 2021 Contact: Yangbo Lu <yangbo.lu@nxp•com> Description: @@ -81,7 +81,7 @@ Description: switches the physical clock back to normal, adjustable operation. -What: /sys/class/ptp/ptpN/pins +What: /sys/class/ptp/ptp<N>/pins Date: March 2014 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -94,7 +94,7 @@ Description: assignment may be changed by two writing numbers into the file. -What: /sys/class/ptp/ptpN/pps_available +What: /sys/class/ptp/ptp<N>/pps_available Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -103,7 +103,7 @@ Description: "1" means that the PPS is supported, while "0" means not supported. -What: /sys/class/ptp/ptpN/extts_enable +What: /sys/class/ptp/ptp<N>/extts_enable Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -113,7 +113,7 @@ Description: To disable external timestamps, write the channel index followed by a "0" into the file. -What: /sys/class/ptp/ptpN/fifo +What: /sys/class/ptp/ptp<N>/fifo Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -121,7 +121,7 @@ Description: the form of three integers: channel index, seconds, and nanoseconds. -What: /sys/class/ptp/ptpN/period +What: /sys/class/ptp/ptp<N>/period Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: @@ -132,7 +132,7 @@ Description: period nanoseconds. To disable a periodic output, set all the seconds and nanoseconds values to zero. -What: /sys/class/ptp/ptpN/pps_enable +What: /sys/class/ptp/ptp<N>/pps_enable Date: September 2010 Contact: Richard Cochran <richardcochran@gmail•com> Description: -- 2.31.1 ^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-09-16 9:00 UTC | newest] Thread overview: 2+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2021-09-16 8:59 [PATCH v3 00/30]Change wildcards on ABI files Mauro Carvalho Chehab 2021-09-16 8:59 ` [PATCH v3 29/30] ABI: sysfs-ptp: use wildcards on What definitions Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox