linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	Fabrice Gasnier <fabrice.gasnier@st.com>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 06/29] ABI: sysfs-bus-rapidio: use wildcards on What definitions
Date: Tue, 14 Sep 2021 16:32:21 +0200	[thread overview]
Message-ID: <e66677d1473dd275b7386f971e0d9fb9eec40ca0.1631629496.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1631629496.git.mchehab+huawei@kernel.org>

While humans may be able to understand that something like:

	/sys/bus/rapidio/devices/nn:d:iiii

could actually mean:

	/sys/bus/rapidio/devices/00:e:0000

This is something that computers can't easily identify. As
get_abi.pl needs to convert it into a regex, change What: lines
to:

	/sys/bus/rapidio/devices/<nn>:<d>:<iiii>

Which is the commonly-used pattern on ABI files for wildcards.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/ABI/testing/sysfs-bus-rapidio | 32 ++++++++++-----------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-rapidio b/Documentation/ABI/testing/sysfs-bus-rapidio
index 634ea207a50a..f8b6728dac10 100644
--- a/Documentation/ABI/testing/sysfs-bus-rapidio
+++ b/Documentation/ABI/testing/sysfs-bus-rapidio
@@ -1,4 +1,4 @@
-What:		/sys/bus/rapidio/devices/nn:d:iiii
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>
 Description:
 		For each RapidIO device, the RapidIO subsystem creates files in
 		an individual subdirectory with the following name format of
@@ -29,7 +29,7 @@ Description:
 Attributes Common for All RapidIO Devices
 -----------------------------------------
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/did
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/did
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -37,7 +37,7 @@ Contact:	Matt Porter <mporter@kernel.crashing.org>,
 Description:
 		(RO) returns the device identifier
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/vid
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/vid
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -45,7 +45,7 @@ Contact:	Matt Porter <mporter@kernel.crashing.org>,
 Description:
 		(RO) returns the device vendor identifier
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/device_rev
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/device_rev
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -53,7 +53,7 @@ Contact:	Matt Porter <mporter@kernel.crashing.org>,
 Description:
 		(RO) returns the device revision level
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/asm_did
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/asm_did
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -61,7 +61,7 @@ Contact:	Matt Porter <mporter@kernel.crashing.org>,
 Description:
 		(RO) returns identifier for the assembly containing the device
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/asm_rev
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/asm_rev
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -70,7 +70,7 @@ Description:
 		(RO) returns revision level of the assembly containing the
 		device
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/asm_vid
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/asm_vid
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -79,7 +79,7 @@ Description:
 		(RO) returns vendor identifier of the assembly containing the
 		device
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/destid
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/destid
 Date:		Mar, 2011
 KernelVersion:	v2.6.3
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -88,7 +88,7 @@ Description:
 		(RO) returns device destination ID assigned by the enumeration
 		routine
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/lprev
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/lprev
 Date:		Mar, 2011
 KernelVersion:	v2.6.39
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -97,7 +97,7 @@ Description:
 		(RO) returns name of previous device (switch) on the path to the
 		device that that owns this attribute
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/modalias
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/modalias
 Date:		Jul, 2013
 KernelVersion:	v3.11
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -105,7 +105,7 @@ Contact:	Matt Porter <mporter@kernel.crashing.org>,
 Description:
 		(RO) returns the device modalias
 
-What:		/sys/bus/rapidio/devices/nn:d:iiii/config
+What:		/sys/bus/rapidio/devices/<nn>:<d>:<iiii>/config
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -128,7 +128,7 @@ device-specific sysfs attributes by specifying a callback function that may be
 set by the switch initialization routine during enumeration or discovery
 process.
 
-What:		/sys/bus/rapidio/devices/nn:s:iiii/routes
+What:		/sys/bus/rapidio/devices/<nn>:<s>:<iiii>/routes
 Date:		Nov, 2005
 KernelVersion:	v2.6.15
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -138,7 +138,7 @@ Description:
 		This attribute reports only valid routing table entries, one
 		line for each entry.
 
-What:		/sys/bus/rapidio/devices/nn:s:iiii/destid
+What:		/sys/bus/rapidio/devices/<nn>:<s>:<iiii>/destid
 Date:		Mar, 2011
 KernelVersion:	v2.6.3
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -147,7 +147,7 @@ Description:
 		(RO) device destination ID of the associated device that defines
 		a route to the switch
 
-What:		/sys/bus/rapidio/devices/nn:s:iiii/hopcount
+What:		/sys/bus/rapidio/devices/<nn>:<s>:<iiii>/hopcount
 Date:		Mar, 2011
 KernelVersion:	v2.6.39
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -155,7 +155,7 @@ Contact:	Matt Porter <mporter@kernel.crashing.org>,
 Description:
 		(RO) number of hops on the path to the switch
 
-What:		/sys/bus/rapidio/devices/nn:s:iiii/lnext
+What:		/sys/bus/rapidio/devices/<nn>:<s>:<iiii>/lnext
 Date:		Mar, 2011
 KernelVersion:	v2.6.39
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
@@ -172,7 +172,7 @@ Device-specific Switch Attributes
 
 IDT_GEN2-
 
-What:		/sys/bus/rapidio/devices/nn:s:iiii/errlog
+What:		/sys/bus/rapidio/devices/<nn>:<s>:<iiii>/errlog
 Date:		Oct, 2010
 KernelVersion:	v2.6.37
 Contact:	Matt Porter <mporter@kernel.crashing.org>,
-- 
2.31.1


  parent reply	other threads:[~2021-09-14 14:36 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-14 14:32 [PATCH v2 00/29] Change wildcards on ABI files Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 01/29] ABI: sysfs-bus-usb: better document variable argument Mauro Carvalho Chehab
2021-09-14 17:31   ` Rajat Jain
2021-09-14 18:57   ` Bjorn Helgaas
2021-09-14 14:32 ` [PATCH v2 02/29] ABI: sysfs-tty: better document module name parameter Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 03/29] ABI: sysfs-kernel-slab: use a wildcard for the cache name Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 04/29] ABI: security: fix location for evm and ima_policy Mauro Carvalho Chehab
2021-09-14 15:53   ` Mimi Zohar
2021-09-14 14:32 ` [PATCH v2 05/29] ABI: sysfs-class-tpm: use wildcards for pcr-* nodes Mauro Carvalho Chehab
2021-09-14 14:32 ` Mauro Carvalho Chehab [this message]
2021-09-14 14:32 ` [PATCH v2 07/29] ABI: sysfs-class-cxl: place "not in a guest" at description Mauro Carvalho Chehab
2021-09-15  3:33   ` Andrew Donnellan
2021-09-14 14:32 ` [PATCH v2 08/29] ABI: sysfs-class-devfreq-event: use the right wildcards on What Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 09/29] ABI: sysfs-class-mic: use the right wildcards on What definitions Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 10/29] ABI: pstore: Fix What field Mauro Carvalho Chehab
2021-09-14 17:35   ` Kees Cook
2021-09-14 14:32 ` [PATCH v2 11/29] ABI: sysfs-class-typec: fix a bad " Mauro Carvalho Chehab
2021-09-14 14:45   ` Heikki Krogerus
2021-09-14 14:32 ` [PATCH v2 12/29] ABI: sysfs-ata: use a proper wildcard for ata_* Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 13/29] ABI: sysfs-class-infiniband: use wildcards on What definitions Mauro Carvalho Chehab
2021-09-14 17:13   ` Jason Gunthorpe
2021-09-14 14:32 ` [PATCH v2 14/29] ABI: sysfs-bus-pci: " Mauro Carvalho Chehab
2021-09-14 18:57   ` Bjorn Helgaas
2021-09-14 14:32 ` [PATCH v2 15/29] ABI: sysfs-bus-soundwire-master: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 16/29] ABI: sysfs-bus-soundwire-slave: " Mauro Carvalho Chehab
2021-09-14 15:28   ` Pierre-Louis Bossart
2021-09-14 14:32 ` [PATCH v2 17/29] ABI: sysfs-class-gnss: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 18/29] ABI: sysfs-class-mei: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 19/29] ABI: sysfs-class-mux: " Mauro Carvalho Chehab
2021-09-15  8:00   ` Peter Rosin
2021-09-14 14:32 ` [PATCH v2 20/29] ABI: sysfs-class-pwm: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 21/29] ABI: sysfs-class-rc: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 22/29] ABI: sysfs-class-rc-nuvoton: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 23/29] ABI: sysfs-class-uwb_rc: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 24/29] ABI: sysfs-class-uwb_rc-wusbhc: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 25/29] ABI: sysfs-devices-platform-dock: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 26/29] ABI: sysfs-devices-system-cpu: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 27/29] ABI: sysfs-firmware-efi-esrt: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 28/29] ABI: sysfs-platform-sst-atom: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 29/29] ABI: sysfs-ptp: " Mauro Carvalho Chehab
2021-09-14 14:47   ` Richard Cochran

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=e66677d1473dd275b7386f971e0d9fb9eec40ca0.1631629496.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=corbet@lwn.net \
    --cc=fabrice.gasnier@st.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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).